Auth

Kakao. Auth

사용자 인증과 관련된 함수들이 포함되어 있습니다.

Methods

(static) authorize(settings)

See:

사용자가 앱에 로그인할 수 있도록 인가 코드를 요청하는 함수입니다. 인가 코드를 받을 수 있는 서버 개발이 필요합니다.

Parameters:
Name Type Description
settings Object

인가 코드 요청과 관련된 설정을 key/value로 전달합니다.

Properties
Name Type Attributes Default Description
redirectUri String <optional>

인가 코드를 받을 URI

state String <optional>

인가 코드 요청과 응답 과정에서 유지할 수 있는 파라미터

scope String <optional>

추가 동의 받을 항목의 키 ex) "account_email,gender"
OpenID Connect 확장 기능 사용 시, 추가 동의 받을 항목의 키와 "openid"를 함께 전달해야 함

prompts String <optional>

인가 코드 요청 시 추가 상호작용을 요청하고자 할 때 전달하는 파라미터 ex) "cert": 인증 로그인, "login": 다른 계정으로 로그인

nonce String <optional>

ID 토큰 재생 공격 방지를 위한 검증 값, 임의의 문자열, ID 토큰 검증 시 사용

throughTalk Boolean <optional>
true

간편 로그인 사용 여부

(static) cleanup()

로그인 버튼을 생성하기 위해 삽입한 iframe을 삭제하고 리소스를 해제합니다.

(static) getAccessToken() → {String}

Returns:

사용 중인 액세스 토큰

Type
String

(static) getAppKey() → {String}

Returns:

사용 중인 앱 키

Type
String

(static) getStatusInfo() → {Promise.<(StatusResponse|AuthError)>}

현재 로그인 상태를 반환합니다.

Returns:
Type
Promise.<(StatusResponse|AuthError)>

(static) logout() → {Promise.<(LogoutResponse|AuthError)>}

See:

현재 로그인되어 있는 사용자를 로그아웃시키고, 액세스 토큰을 삭제합니다.

Returns:
Type
Promise.<(LogoutResponse|AuthError)>

(static) setAccessToken(token, persistopt)

API 호출 시 사용할 액세스 토큰을 설정합니다.

Parameters:
Name Type Attributes Default Description
token String

사용할 액세스 토큰

persist Boolean <optional>
true

새로고침을 하더라도 액세스 토큰을 사용할 수 있도록 sessionStorage 저장 여부

Type Definitions

AuthError

Properties:
Name Type Description
error Object
Properties
Name Type Description
code Number

에러 코드

msg String

에러 메시지

LogoutResponse

Properties:
Name Type Description
userInfo Object
Properties
Name Type Description
id Number

회원번호

StatusResponse

Properties:
Name Type Description
statusInfo Object
Properties
Name Type Description
status String

"connected" 또는 "not_connected"

user Object

로그인 상태일 때만 전달되는 사용자 정보