이 문서는 카카오 로그인 사용 시 필요한 설정에 대해 안내합니다. 이 문서의 모든 설정은 카카오디벨로퍼스(Kakao Developers)의 [내 애플리케이션]에서 설정할 수 있습니다.
각 제목에 부착된 태그(Tag)는 아래와 같은 의미입니다.
태그 | 설명 |
---|---|
필수 | 반드시 필요한 설정입니다. |
선택 | 필요 시 사용하는 설정입니다. |
권장 | 사용을 권장하는 설정입니다. |
[내 애플리케이션] > [카카오 로그인]에서 카카오 로그인 사용에 필요한 설정을 할 수 있습니다.
카카오 로그인을 사용하려면 카카오 로그인 활성화 설정, Redirect URI 등록은 반드시 설정해야 합니다. OpenID Connect 활성화 설정은 필요 시 설정합니다.
카카오 로그인을 사용하려면 [내 애플리케이션] > [카카오 로그인] > [활성화 설정]의 [상태]를 [ON]으로 설정해야 합니다. [상태]가 [OFF]인 경우, 카카오 로그인 요청 시 KOE004
에러가 발생합니다.
OpenID Connect를 활성화하면 카카오 로그인 시 액세스 토큰과 ID 토큰을 함께 발급받을 수 있습니다. 아래 내용을 참고해 [내 애플리케이션] > [카카오 로그인]에서 OpenID Connect를 사용하도록 설정합니다.
[OpenID Connect 활성화] 설정을 [OFF]로 변경하면, 설정 변경 시점부터 ID 토큰이 발급되지 않습니다. 서비스에서 ID 토큰을 사용 중인 경우에는 로그인이 불가능할 수 있으므로 주의합니다.
REST API 또는 Kakao SDK for JavaScript로 카카오 로그인을 사용한다면 Redirect URI를 반드시 등록해야 합니다. Redirect URI는 OAuth 2.0을 기반으로 동작하는 카카오 로그인의 핵심 요소입니다. 카카오 로그인은 서비스 로그인 과정에서 Redirect URI를 통해 서비스에서 요청한 인가 코드와 토큰을 전달합니다. Redirect URI를 올바르게 등록하지 않은 경우, 카카오 로그인 시 KOE006
에러가 발생합니다.
[내 애플리케이션] > [카카오 로그인] > [Redirect URI] > [Redirect URI 등록]에서 Redirect URI를 등록합니다.
Redirect URI는 아래 규칙에 맞게 등록해야 합니다.
state
파라미터를 활용합니다. state
파라미터에 대한 정보는 인가 코드 받기에서 확인할 수 있습니다.[내 애플리케이션] > [카카오 로그인] > [동의 화면 미리보기]를 눌러 실제 카카오 로그인 시 사용자가 보게 될 동의 화면의 구성 요소를 확인할 수 있습니다.
[내 애플리케이션] > [카카오 로그인] > [동의항목]의 동의항목별 [설정]을 눌러 사용 여부와 동의 단계를 설정할 수 있습니다. 개인정보 동의항목은 [개인정보], 접근권한 동의항목은 [접근권한]에서 각각 설정합니다.
🅐 동의 단계: 설정 가능한 동의 단계와 설정 권한 획득 방법은 개인정보 동의항목과 접근권한 동의항목 참고 🅑 카카오계정으로 정보 수집 후 제공: 옵션 사용 여부 설정 🅒 동의 목적: 동의항목 사용 목적에 대한 참고 정보, 카카오 로그인 동의 화면에 출력되지 않음
앱의 동의항목 설정 내역은 카카오 로그인 동의 화면에 반영됩니다. 아래는 🅐 [필수 동의], 🅑 [선택 동의] 동의항목을 각각 포함한 동의 화면의 예시입니다. 실제 앱의 설정을 반영한 동의 화면은 동의 화면 미리보기로 확인할 수 있습니다.
[내 애플리케이션] > [카카오 로그인] > [간편가입]에서 간편가입을 설정할 수 있습니다.
간편가입을 사용하려면 카카오톡 채널 연결 후 [내 애플리케이션] > [카카오 로그인] > [간편가입]에서 [사용 여부]를 [ON]으로 설정합니다. [사용 여부]를 [ON]으로 설정해야 카카오 로그인 동의 화면에 서비스 약관을 포함하고, 앱의 서비스 약관을 설정할 수 있습니다.
[내 애플리케이션] > [카카오 로그인] > [간편가입]에서 [서비스 약관 추가]를 눌러 새로운 서비스 약관을 등록할 수 있습니다. 서비스 약관 운용을 준수해야 합니다.
🅐 서비스 약관 제목: 한국어, 영어 모두 입력 🅑 서비스 약관 URL: 약관 내용을 확인할 수 있는 웹 페이지 URL 입력 🅒 서비스 약관 조건: 필수 동의항목 또는 선택 동의항목 중 선택 🅓 태그: 각 서비스 약관을 가리키는 고유값 입력
등록 가능한 서비스 약관 형식은 아래와 같습니다.
${KEYWORD}_${DATE}
, ${KEYWORD}_${ORDER}
등 형식 권장(예: terms_20220701
, terms_01
)[내 애플리케이션] > [카카오 로그인] > [간편가입]에서 등록된 서비스 약관을 관리할 수 있습니다.
🅐 상태 변경: 활성화 시 카카오 로그인 동의 화면에 노출, 비활성화 시 카카오 로그인 동의 화면에 비노출 🅑 수정: 등록된 서비스 약관 수정, 변경사항이 있는 경우에만 [저장] 활성화 🅒 순서 변경: 카카오 로그인 동의 화면의 서비스 약관 노출 순서 변경, 활성화 상태와 무관하게 지정 가능
카카오디벨로퍼스 앱에 서비스의 카카오톡 채널을 연결할 수 있습니다. 서비스는 앱과 카카오톡 채널을 연결함으로써 더욱 효과적으로 카카오톡 채널을 통한 마케팅을 할 수 있습니다.
같은 사업자가 소유한 앱과 카카오톡 채널만 연결 가능합니다. 동일한 사업자 정보를 등록해 앱을 비즈 앱, 카카오톡 채널을 비즈니스 채널로 각각 전환해야 연결할 수 있습니다.
카카오톡 채널을 앱에 연결하려면 앱 권한 신청이 필요합니다. 아래 단계별 내용을 확인합니다.
1. 신청 자격 확인앱의 오너(OWNER) 또는 에디터(EDITOR) 권한 보유 계정으로 로그인 후, [내 애플리케이션] > [앱 설정] > [앱 권한 신청]에서 [신청 자격 확인]을 누릅니다. 신청 자격의 내용을 확인한 뒤 동의해야 합니다.
[앱 권한 신청] > [앱 권한]에서 앱 권한 목록의 카카오톡 채널 연결을 신청하면 연결 가능 카카오톡 채널이 목록에 나타납니다. 원하는 채널을 선택하고 [연결]을 누르면 앱과 카카오톡 채널이 연결됩니다.
연결한 채널은 카카오톡 채널 연결 관리에서 확인하고 필요한 경우 연결 해제할 수 있습니다.
다음 조건을 만족하는 카카오톡 채널을 앱과 연결할 수 있습니다.
비즈니스 채널은 서비스를 소유한 사업자 정보를 등록한 카카오톡 채널입니다. 카카오톡 채널을 비즈니스 채널로 전환 신청하는 방법은 아래 안내를 참고합니다.
서비스에 영향을 미치지 않는 테스트용 카카오톡 채널이 필요한 경우, 카카오톡 채널 관리자센터에서 [개발자용 채널 만들기]를 눌러 개발자용 채널을 생성할 수 있습니다. 최소 1개의 비즈니스 채널이 있어야 해당 버튼이 노출됩니다. 개발자용 채널은 테스트 앱에 연결하고 대표 채널로 설정하여 사용합니다.
대표 채널은 카카오 로그인 시 동의 화면에 노출되는 카카오톡 채널입니다. 대표 채널을 설정하면 카카오 로그인 동의 화면에 아래와 같이 카카오톡 채널 추가 항목이 노출됩니다. 이를 통해 사용자가 카카오 로그인 시 서비스의 카카오톡 채널을 추가할 수 있습니다.
앱에 카카오톡 채널 연결 후, 연결된 카카오톡 채널 중 하나를 대표 채널로 설정할 수 있습니다. [내 애플리케이션] > [카카오 로그인] > [카카오톡 채널]에서 [대표 채널 선택]을 눌러 대표 채널을 설정합니다.
대표 채널을 설정하면 [내 애플리케이션] > [카카오 로그인] > [카카오톡 채널] > [대표 채널]에 아래와 같이 대표 채널 정보가 나타납니다. [대표 채널]의 [수정]을 누르면 다른 대표 채널을 다른 카카오톡 채널로 변경할 수 있습니다.
앱에 카카오톡 채널 연결 후, 카카오톡 채널 관계 확인하기 API를 사용하려면 동의항목을 설정하고 사용자의 동의를 받아야 합니다. [내 애플리케이션] > [카카오 로그인] > [동의항목]에서 [카카오톡 채널 추가 상태 및 내역]을 [필수 동의] 또는 [선택 동의] 동의 단계로 설정합니다. 해당 동의항목은 앱과 연결된 카카오톡 채널이 있는 경우에만 설정 가능합니다.
[내 애플리케이션] > [카카오 로그인] > [개인정보 국외이전]에서 개인정보 국외이전 정보를 등록할 수 있습니다.
🅐 이전되는 국가: 개인정보가 이전되는 국가명 입력 🅑 법인명(업체): 개인정보를 이전받는 법인명 입력 🅒 연락처: 정보관리책임자의 이메일, 전화번호, 고객센터 URL 등 개인정보 관련 문의를 위한 🅑의 연락처 입력 🅓 저장: 입력한 정보 저장
입력한 정보를 토대로 카카오 로그인 동의 화면에 [개인정보 국외 이전 동의] 필수 동의항목이 추가됩니다. 사용자는 해당 동의항목을 통해 개인정보 국외이전에 대해 확인하고 동의할 수 있습니다. 각 입력 항목은 아래와 같이 동의 화면에 출력됩니다.
[내 애플리케이션] > [카카오 로그인] > [연결 끊기]에서 연결 끊기 알림을 설정할 수 있습니다.
[연결 끊기 등록]를 눌러 연결 끊기 알림을 전달받을 콜백 정보를 설정할 수 있습니다.
[콜백 URL]에 콜백(Callback)을 받아 처리할 사이트 도메인 주소, 요청 방법(Method) 및 요청 주소(Path)를 입력합니다. 콜백 URL은 사용자 정보 보호를 위해 HTTPS만 지원하며, 443 포트(Port)만 등록 가능합니다.
연결 끊기 등록 시, 아래 화면과 같이 등록한 콜백 정보를 확인할 수 있습니다. [수정]으로 설정 변경, [삭제]로 설정 삭제가 가능합니다. 기능 사용을 중단하려면 [활성화 상태]를 [사용안함]으로 설정합니다.
장기간 콜백 수신 응답이 없거나 오류 발생 빈도가 높은 경우, 카카오 API 플랫폼은 더 이상 콜백을 전달하지 않고 연결 끊기 설정의 [활성화 상태]를 [일시중지]로 변경합니다. 앱 팀원의 메일로 발송된 안내를 참고하여 콜백 처리가 올바르게 이뤄지는지 확인 및 조치 후, [활성화 상태]를 [사용함]으로 변경해야 다시 콜백을 전달받을 수 있습니다.
[내 애플리케이션] > [카카오 로그인] > [사용자 프로퍼티]에서 사용자 프로퍼티 키를 등록할 수 있습니다. 서비스마다 총 5개의 사용자 프로퍼티 키를 등록할 수 있습니다.
nickname
, profile_image
, thumbnail_image
는 카카오 플랫폼에서 사용하는 예약어이므로 사용자 프로퍼티 키 등록 시 사용할 수 없습니다.
2022년 5월 12일부터 프로필 정보 저장을 위해 기본 제공되던 프로퍼티인 nickname, profile_image, thumbnail_image의 값이 실시간 카카오계정 프로필 값으로 변경되고, 사용자 정보 저장하기를 통한 값 업데이트를 지원하지 않습니다. 자세한 사항은 공지를 참고합니다.
[내 애플리케이션] > [카카오 로그인] > [보안]에서 [코드 생성]를 눌러 클라이언트 시크릿(Client Secret) 코드를 발급받을 수 있습니다.
발급된 클라이언트 시크릿 코드는 [활성화 상태]의 [설정]을 눌러 [사용함]으로 변경해야 적용됩니다. Client Secret을 사용하지 않도록 변경하려면 [활성화 상태]를 [사용안함]으로 변경합니다.
[코드]의 [재발급]을 눌러 새로운 클라이언트 시크릿 코드를 발급받을 수 있습니다. 코드를 갱신하거나 유출이 의심되는 상황에서 사용할 수 있습니다. 운영 중인 서비스에서 코드 재발급 시, 기존 코드를 사용한 토큰 발급 요청이 모두 실패하게 되므로 주의합니다.
[내 애플리케이션] > [카카오 로그인] > [보안 이벤트]에서 [구독 설정]을 눌러 보안 이벤트 구독 설정을 할 수 있습니다.
[보안 이벤트 구독 설정] 화면에서 상세 정보를 입력합니다.
🅐 활성화 상태: 보안 이벤트 구독 여부 선택 🅑 콜백 URL: 보안 이벤트 정보를 전달받을 서비스의 콜백 URL 입력, HTTPS만 지원 🅒 구독대상 이벤트: 구독할 보안 이벤트 카테고리 및 타입 선택 ⓐ 카테고리: 권한이 있는 앱에만 노출되는 항목, 구독할 보안 이벤트 카테고리 선택 ⓑ 타입: 구독할 보안 이벤트 타입 선택
아래는 보안 이벤트 설정 완료 후 상세 정보 화면입니다.
🅐 삭제 및 수정: 보안 이벤트 구독 설정 내용 변경 또는 삭제 🅑 보안 이벤트 테스트 도구 바로가기: 설정 및 기능 구현 확인을 위한 테스트 도구 바로가기 🅒 이벤트 설정: 콜백 URL 정보 🅓 구독대상 이벤트: 구독 중인 보안 이벤트 타입 정보
장기간 보안 이벤트 수신 응답이 없거나 오류 발생 빈도가 높은 경우, 카카오 API 플랫폼은 더 이상 보안 이벤트를 전달하지 않고 [활성화 상태]를 [사용안함]로 변경합니다. 앱 팀원의 메일로 발송된 안내를 참고하여 보안 이벤트 처리가 올바르게 이뤄지는지 확인 및 조치 후, [활성화 상태]를 [사용함]으로 변경해야 다시 보안 이벤트를 전달받을 수 있습니다.
카카오계정과 함께 로그아웃 기능을 사용하려면 [제품 설정] > [카카오 로그인] > [고급] > [Logout Redirect URI]에서 Logout Redirect URI를 등록해야 합니다.
Logout Redirect URI는 HTTP/HTTPS 프로토콜 및 80, 443 포트를 지원하며, HTTP/HTTPS 프로토콜을 구분하므로 각각 등록해야 합니다. 최대 10개의 Logout Redirect URI 등록이 가능하며, 10개 초과 등록이 필요한 경우 데브톡으로 문의합니다.