사용자 인증과 관련된 함수들이 포함되어 있습니다.
Methods
-
<static> authorize(settings)
-
사용자가 앱에 로그인할 수 있도록 인증코드를 요청하는 함수입니다. 인증코드를 받을 수 있는 서버 개발이 필요합니다.
Parameters:
Name Type Description settings
Object 로그인과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description redirectUri
String <optional>
인증코드를 받을 URI
state
String <optional>
인증코드 요청과 응답 과정에서 유지할 수 있는 파라미터
throughTalk
Boolean <optional>
true 간편 로그인 사용 여부
reauthenticate
Boolean <optional>
false 다른 계정으로 로그인 사용 여부
scope
String <optional>
로그인 시 동의받아야 하는 항목. ex) "account_email,birthday"
- See:
-
<static> cleanup()
-
로그인 버튼을 생성하기 위해 삽입한 iframe을 삭제하고 리소스를 해제합니다.
-
<static> createLoginButton(settings)
-
카카오 로그인 버튼을 생성합니다.
Parameters:
Name Type Description settings
Object 로그인 버튼과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description container
String | HTMLElement DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element 내부에 로그인 버튼이 생성됩니다.
lang
String <optional>
"kr" 로그인 버튼에 표시할 언어, "kr"|"en"
size
String <optional>
"medium" 로그인 버튼의 사이즈, "small"|"medium"|"large"
success
AuthSuccessCallback <optional>
로그인이 성공할 경우 사용자 토큰을 받을 콜백 함수
fail
AuthFailCallback <optional>
로그인이 실패할 경우 에러를 받을 콜백 함수
always
AuthSuccessCallback | AuthFailCallback <optional>
로그인이 성공한 경우 및 실패한 경우 모두 호출할 콜백 함수
persistAccessToken
Boolean <optional>
true 세션이 종료된 뒤에도 Access Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.
persistRefreshToken
Boolean <optional>
false 세션이 종료된 뒤에도 Refresh Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.
scope
String <optional>
로그인 시 동의받아야 하는 항목. ex) "account_email,birthday"
- See:
-
- Kakao.Auth.login 직접 로그인 버튼을 제작하여 사용할 때 이용하세요.
- 데모 보러가기
-
<static> getAccessToken()
-
Returns:
사용중인 Access Token
- Type
- String
-
<static> getAppKey()
-
Returns:
사용중인 App Key
- Type
- String
-
<static> getRefreshToken()
-
- Deprecated:
-
- 이 API는 보안 정책으로 인해 폐기되었습니다.
-
<static> getStatusInfo( [callback])
-
현재 로그인 상태를 반환합니다.
Parameters:
Name Type Argument Description callback
AuthStatusCallback <optional>
로그인 상태를 반환할 콜백 함수
-
<static> login(settings)
-
사용자가 앱에 로그인할 수 있도록 로그인 팝업창을 띄우는 함수입니다. 사용자의 클릭 이벤트 이후에 호출되어야 브라우저에 의해 팝업이 차단되지 않습니다.
Parameters:
Name Type Description settings
Object 로그인과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description success
AuthSuccessCallback <optional>
로그인이 성공할 경우 사용자 토큰을 받을 콜백 함수
fail
AuthFailCallback <optional>
로그인이 실패할 경우 에러를 받을 콜백 함수
always
AuthSuccessCallback | AuthFailCallback <optional>
로그인이 성공한 경우 및 실패한 경우 모두 호출할 콜백 함수
persistAccessToken
Boolean <optional>
true 세션이 종료된 뒤에도 Access Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.
persistRefreshToken
Boolean <optional>
false 세션이 종료된 뒤에도 Refresh Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.
throughTalk
Boolean <optional>
true 간편 로그인 사용 여부
scope
String <optional>
로그인 시 동의받아야 하는 항목. ex) "account_email,birthday"
- See:
-
- Kakao.Auth.createLoginButton 직접 로그인 버튼을 제작하여 사용할 필요가 없는 경우 유용합니다.
- 데모 보러가기
-
<static> loginForm(settings)
-
다른 계정으로 로그인할 수 있도록 로그인 팝업창을 띄우는 함수입니다. 사용자의 클릭 이벤트 이후에 호출되어야 브라우저에 의해 팝업이 차단되지 않습니다.
Parameters:
Name Type Description settings
Object 로그인과 관련된 설정을 key/value로 전달합니다.
Properties
Name Type Argument Default Description success
AuthSuccessCallback <optional>
로그인이 성공할 경우 사용자 토큰을 받을 콜백 함수
fail
AuthFailCallback <optional>
로그인이 실패할 경우 에러를 받을 콜백 함수
always
AuthSuccessCallback | AuthFailCallback <optional>
로그인이 성공한 경우 및 실패한 경우 모두 호출할 콜백 함수
persistAccessToken
Boolean <optional>
true 세션이 종료된 뒤에도 Access Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.
persistRefreshToken
Boolean <optional>
false 세션이 종료된 뒤에도 Refresh Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.
scope
String <optional>
로그인 시 동의받아야 하는 항목. ex) "account_email,birthday"
-
<static> logout( [callback])
-
현재 로그인되어 있는 사용자를 로그아웃시키고, Access Token을 삭제합니다.
Parameters:
Name Type Argument Description callback
function <optional>
로그아웃 후 호출할 콜백 함수
-
<static> setAccessToken(token [, persist])
-
API호출시 사용할 Access Token을 설정합니다.
Parameters:
Name Type Argument Default Description token
String 사용할 Access Token
persist
Boolean <optional>
false 세션이 종료된 뒤에도 Access Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.
-
<static> setRefreshToken()
-
- Deprecated:
-
- 이 API는 보안 정책으로 인해 폐기되었습니다.
Type Definitions
-
AuthFailCallback(errorObj)
-
Parameters:
Name Type Description errorObj
Object Properties
Name Type Description error
String 고정값 "access_denied"
error_description
String -
AuthSuccessCallback(authObj)
-
Parameters:
Name Type Description authObj
Object Properties
Name Type Description access_token
String refresh_token
String token_type
String 고정값 "bearer"
expires_in
Number scope
String