This document explains what you have to do before integrating Kakao Login.
To use Kakao Login, you must set Usage settings and Redirect URI. Set OpenID Connect when necessary.
Tag | Description |
---|---|
Required | You must apply the settings marked with this tag before integrating Kakao Login into your service. |
To use Kakao Login, set [State] in [Kakao Login] > [Enable] on the app management page to [ON]. If [Status] is set to [OFF], a KOE004
error occurs when requesting Kakao Login.
When OpenID Connect is enabled, both an access token and an ID token are issued when logging in with Kakao Login. Follow the steps below to enable OpenID Connect in [Kakao Login] > [OpenID Connect] on the app management page.
If you change [OpenID Connect] to [OFF], ID tokens will no longer be issued from the time of the change. If your service uses ID tokens, login may fail, so exercise caution.
When using Kakao Login with the REST API or Kakao SDK for JavaScript, you must register a redirect URI. The redirect URI is a key element of Kakao Login, which is based on OAuth 2.0. During the service login process, Kakao Login delivers the requested authorization code and token to the redirect URI. If the redirect URI is invalid, a KOE006
error occurs during Kakao Login.
You can register a redirect URI in [Kakao Login] > [General] > [Redirect URI] on the app management page.
When you register Redirect URIs, you must comply with the below rules.
state
parameter. For information on the state
parameter, see Get authorization code.You can use a client secret to enhance the security of Kakao Login.
Select [Issue client secret] in [Kakao Login] > [General] > [Client Secret] on the app management page.
🅐 Delete: Deletes the issued client secret. 🅑 Reissue: Generates a new client secret. Can be used when updating the client secret or when leakage is suspected. 🅒 Set: Changes client status. Its status must be [Enable] to use the client secret.
When you delete or reissue a client secret, the previous code cannot be recovered, which causes all requests for token issuance using the previous client secret to fail.
A consent item is a setting that allows the service to obtain user permission to access specific information or use features. For the details and a full list, see Consent items.
You can enable consent items in [Kakao Login] > [Consent items] on the app management page. For the details on configuration, see the descriptions by item below.
Some consent items require additional feature permissions to be enabled. The required permissions for each item to set consent items can be found in Personal information consent items and Access permission consent items.
For how to request consent item permissions, see Request additional features.
You can set consent items required for retrieving service information or using features. See the step-by-step guide below.
Check what items require user consent in your service by referring to 🅐 Personal information consent items and 🅑 Access permission consent items.
Select [Set] for the desired consent item in either [Personal information] or [Access permission]. For some consent items, you must first complete Request additional features before configuring them.
🅐Select consent types and enter the usage purpose in 🅑 consent purpose, then select [Save].
You can check the components of the consent screen that users will see during actual Kakao Login by selecting [Preview Consent Screen] under [Kakao Login] > [Consent items] on the app management page.
The primary channel is the Kakao Talk Channel displayed on the consent screen during Kakao Login.
You can register Transfer of personal information overseas information in [Kakao Login] > [Consent items] > [Transfer of personal information overseas] on the app management page.
🅐 Country where personal information is stored: Enter the name of the country where personal information will be transferred. 🅑 Corporation name: Enter the name of the corporation that will receive the personal information. 🅒 Contact: Enter the contact information of 🅑 for personal information inquiries, such as the email address, phone number, or customer service URL of the person responsible for information management.
Based on the information entered, the [Consent to transfer personal information overseas] required consent item is added to the Kakao Login consent screen. Users can select [view more] for this item to check the details and agree.
The Simple Signup feature, you can display service terms configured in your app on the Kakao Login consent screen to easily obtain user consent for the terms.
To use Simple Signup, follow as below.
You can register a new service terms by selecting [Add a service term] in [Kakao Login] > [Simple Signup] on the app management page. You must comply with Service terms management.
🅐 Add a service term: Registers information of a service term. 🅑 Add age consent for age 14 and over 🅒 List of enabled terms: Displays the terms that are set to use (ON) among registered terms. 🅓 Inactivated service terms: Displays the terms that are not used (OFF) among registered terms. 🅔 Preview Consent Screen: Displays preview of Kakao Login consent screen reflecting the set terms. 🅕 Change order: Changes the display order of service terms on the Kakao Login consent screen. 🅖 Edit: Changes the settings for each term. 🅗 Usage setting: Select whether to display on Kakao Login consent screen.
When adding service terms, you must set the following information.
🅐 Title: Enter both Korean and English titles. 🅑 URL: Enter the web page URL where the terms content can be checked. 🅒 Consent level: Select the consent level to request consent from users (required or optional consent item). 🅓 Tag: Enter a unique value to distinguish each service terms.
Refer to the below for the available formats for each item.
${KEYWORD}_${DATE}
, ${KEYWORD}_${ORDER}
(e.g., terms_20220701
, terms_01
).You can use the Logout of service and Kakao Account feature by registering the logout redirect URI in [Kakao Login] > [Advanced] > [Logout redirect URI] on the app management page.
The logout redirect URI supports HTTP/HTTPS protocols and ports 80 and 443, and distinguishes between HTTP and HTTPS protocols, so each must be registered separately. Up to 10 logout redirect URIs can be registered. If you need to register more than 10, contact DevTalk.
You can register user property keys and check the stored values for members linked to the app in [Kakao Login] > [Advanced] > [User property] on the app management page. Up to 5 user property keys (excluding user property reserved keys) can be registered per service.
🅐 Add property key 🅑 Delete property key 🅒 Account information: Account information of members linked to the app. 🅓 Reserved property: User property reserved keys and stored values. 🅔 User property: Added user property keys and stored values.
nickname
, profile_image
, and thumbnail_image
are reserved keys used by the Kakao platform and cannot be used for user property key registration.
From May 12, 2022, the values of the default properties nickname, profile_image, and thumbnail_image for profile storage are changed to real-time Kakao Account profile values, and updating values using Store user information is no longer supported. For details, see the notice.