내 애플리케이션: 카카오 로그인

신규 어드민 API 제공

이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.

이 문서는 카카오디벨로퍼스 앱(애플리케이션)의 카카오 로그인 제품 설정에 대한 어드민 API 사용 방법을 안내합니다.

제목 태그

각 제목에 부착된 태그(Tag)는 아래와 같은 의미입니다.

태그	설명
Internal	이 액션은 API플랫폼 내부에서만 사용합니다.

카카오 로그인 기본 설정

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/oauth`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND	카카오 로그인 기본 설정을 조회합니다.
FIND_STATUS	카카오 로그인 활성화 여부를 조회합니다.
UPDATE_STATUS	카카오 로그인 활성화 여부를 변경합니다.
ADD_REDIRECT_URI	카카오 로그인 리다이렉트 URI를 추가합니다.
UPDATE_REDIRECT_URI	카카오 로그인 리다이렉트 URI를 수정합니다.
UPDATE_LOGOUT_REDIRECT_URI	카카오 로그인 로그아웃 리다이렉트 URI를 수정합니다.

FIND

카카오 로그인 기본 설정을 조회합니다.

요청 처리 성공 시 응답은 앱의 카카오 로그인 기본 설정을 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

OAuthConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159109,
  "status": "ACTIVE",
  "redirect_uri": ["https://www.kakao.com/login"]
}

FIND_STATUS

카카오 로그인 활성화 여부를 조회합니다.

요청 처리 성공 시 응답은 앱의 카카오 로그인 활성화 여부를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

카카오 로그인 활성화 여부
- ACTIVE: 활성
- DEACTIVATED: 비활성

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_STATUS"
    }'

응답 예제

// HTTP/2 200
"ACTIVE"

UPDATE_STATUS

카카오 로그인 활성화 여부를 변경합니다.

payload 하위의 status 값으로 변경하고자 하는 상태를 전달합니다.

요청 처리 성공 시 응답은 변경 후 앱의 카카오 로그인 기본 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
status	`String`	카카오 로그인 활성화 여부 `ACTIVE`: 활성 `DEACTIVATED`: 비활성	O

응답 페이로드

OAuthConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE_STATUS",
        "payload": {
            "status": "ACTIVE"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159109,
  "status": "ACTIVE",
  "redirect_uri": ["https://www.kakao.com/login"]
}

ADD_REDIRECT_URI

카카오 로그인 리다이렉트 URI를 추가합니다. 이미 앱에 리다이렉트 URI가 등록되어 있다면 추가 등록합니다. 기존에 등록돼 있는 리다이렉트 URI는 중복 등록되지 않습니다.

payload 하위의 redirect_uri에 추가할 리다이렉트 URI 목록을 전달합니다.

요청 처리 성공 시 응답은 리다이렉트 URI 추가 후 앱의 카카오 로그인 기본 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
redirect_uri	`String[]`	카카오 로그인 리다이렉트 URI 최대 10개까지 등록 가능 참고: 리다이렉트 URI 등록	O

응답 페이로드

OAuthConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "ADD_REDIRECT_URI",
        "payload": {
            "redirect_uri": ["https://sample.com/login"]
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159109,
  "status": "ACTIVE",
  "redirect_uri": ["https://sample.com/login"]
}

UPDATE_REDIRECT_URI

카카오 로그인 리다이렉트 URI를 수정합니다. 이미 리다이렉트 URI가 등록돼 있다면 삭제하고 수정하려는 리다이렉트 URI를 추가합니다.

payload 하위의 redirect_uri에 수정할 리다이렉트 URI 목록을 전달합니다.

요청 처리 성공 시 응답은 리다이렉트 URI 수정 후 앱의 카카오 로그인 기본 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
redirect_uri	`String`	카카오 로그인 리다이렉트 URI 최대 10개까지 등록 가능 참고: 리다이렉트 URI 등록	O

응답 페이로드

OAuthConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE_REDIRECT_URI",
        "payload": {
            "redirect_uri": ["https://sample.kakao.com/login"]
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159109,
  "status": "ACTIVE",
  "redirect_uri": ["https://sample.kakao.com/login"]
}

UPDATE_LOGOUT_REDIRECT_URI

카카오 로그인 로그아웃 리다이렉트 URI를 수정합니다. 로그아웃 리다이렉트 URI는 카카오계정과 함께 로그아웃 시 사용합니다.

payload 하위의 logout_redirect_uri에 수정할 로그아웃 리다이렉트 URI 목록을 전달합니다.

요청 처리 성공 시 응답은 리다이렉트 URI 수정 후 앱의 카카오 로그인 기본 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
logout_redirect_uri	`String`	카카오 로그인 로그아웃 리다이렉트 URI 최대 10개까지 등록 가능 참고: 로그아웃 리다이렉트 URI 등록	O

응답 페이로드

OAuthConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE_LOGOUT_REDIRECT_URI"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159109,
  "status": "ACTIVE",
  "redirect_uri": ["https://sample.com/login"],
  "logout_redirect_uri": ["https://sample.com/logout"]
}

카카오 로그인 추가 설정

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/user/management`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND Internal	카카오 로그인 추가 설정을 조회합니다.
UPDATE Internal	카카오 로그인 추가 설정을 수정합니다.
UPDATE_AUTO_REGISTER_ON_LOGIN Internal	자동 연결 설정을 수정합니다.
UPDATE_KEEP_USER_ID Internal	사용자 ID 고정 설정을 수정합니다.
UPDATE_NOT_ALLOWED_UNDER_AGE14 Internal	만 14세 미만 사용자 로그인 차단 설정을 수정합니다.

FIND
Internal

카카오 로그인 추가 설정을 조회합니다. 카카오 로그인은 아래 추가 설정을 제공합니다.

요청 처리 성공 시 응답은 앱의 카카오 로그인 추가 설정 상태를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

UserManagementSettings

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/management" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "auto_register_on_login": true,
  "lazy_age_auth": false,
  "forced_agreement": false,
  "keep_user_id": true
}

UPDATE
Internal

카카오 로그인 추가 설정을 수정합니다.

payload 하위의 settings에 수정할 추가 설정의 상태 값을 전달합니다.

요청 처리 성공 시 응답은 수정된 카카오 로그인 추가 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
auto_register_on_login	`Boolean`	자동 연결 설정 활성화 여부 `true`: 자동 연결 `false`: 수동 연결	X
lazy_age_auth	`Boolean`	연령인증 중 필요 시 연령인증 방식 사용 여부 `true`: 사용 `false`: 미사용	X
forced_agreement	`Boolean`	인하우스 앱에 동의 화면 강제 호출 기능 사용 여부 `true`: 사용 `false`: 미사용 참고: 인하우스 앱의 카카오 로그인	X

응답 페이로드

UserManagementSettings

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/management" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "auto_register_on_login": true,
            "lazy_age_auth": false,
            "forced_agreement": false
        }
    }'

응답 예제

// HTTP/2 200
{
  "auto_register_on_login": true,
  "lazy_age_auth": false,
  "forced_agreement": false,
  "keep_user_id": true
}

UPDATE_AUTO_REGISTER_ON_LOGIN
Internal

자동 연결 설정을 수정합니다.

payload 하위의 auto_register_on_login에 자동 연결 설정 활성화 여부를 전달합니다.

요청 처리 성공 시 응답은 수정된 카카오 로그인 추가 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
auto_register_on_login	`Boolean`	자동 연결 설정 활성화 여부 `true`: 자동 연결 `false`: 수동 연결	O

응답 페이로드

UserManagementSettings

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/management" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE_AUTO_REGISTER_ON_LOGIN",
        "payload": {
            "auto_register_on_login": true
        }
    }'

응답 예제

// HTTP/2 200
{
  "auto_register_on_login": true,
  "lazy_age_auth": false,
  "forced_agreement": false,
  "keep_user_id": true
}

UPDATE_KEEP_USER_ID
Internal

사용자 ID 고정 설정을 수정합니다.

payload 하위의 keep_user_id에 사용자 ID 고정 활성화 여부를 전달합니다.

요청 처리 성공 시 응답은 수정된 카카오 로그인 추가 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
keep_user_id	`Boolean`	사용자 ID 고정 설정 활성화 여부 `true`: 사용자 ID 고정 활성화 `false`: 사용자 ID 고정 비활성화	O

응답 페이로드

UserManagementSettings

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/management" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
       "name": "UPDATE_KEEP_USER_ID",
        "payload": {
            "keep_user_id": true
        }

    }'

응답 예제

// HTTP/2 200
{
  "auto_register_on_login": true,
  "lazy_age_auth": false,
  "forced_agreement": false,
  "keep_user_id": true
}

UPDATE_NOT_ALLOWED_UNDER_AGE14
Internal

만 14세 미만 사용자 로그인 차단 설정을 수정합니다.

payload 하위의 not_allowed_under_age14에 14세 미만 사용자 로그인 차단 여부를 전달합니다.

요청 처리 성공 시 응답은 수정된 카카오 로그인 추가 설정을 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
not_allowed_under_age14	`Boolean`	만 14세 미만 사용자 로그인 차단 사용 여부 `true`: 사용 `false`: 미사용	X

응답 페이로드

UserManagementSettings

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/management" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "name": "UPDATE_NOT_ALLOWED_UNDER_AGE14",
        "payload": {
            "not_allowed_under_age14": false
        }
    }'

응답 예제

// HTTP/2 200
{
  "auto_register_on_login": true,
  "lazy_age_auth": false,
  "forced_agreement": false,
  "keep_user_id": true,
  "not_allowed_under_age14": false
}

카카오톡 채널

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/oauth/kakaoTalkChannel`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL	앱과 연결된 카카오톡 채널 ID 목록을 조회합니다.
FIND_ALL_KAKAO_TALK_CHANNEL Internal	앱과 연결된 카카오톡 채널 정보 목록을 조회합니다.
ADD	앱과 카카오톡 채널을 연결합니다.
ADD_ALL	앱과 여러 개의 카카오톡 채널을 연결합니다.
UPDATE	앱과 연결된 카카오톡 채널을 변경합니다.
UPDATE_ALL	앱과 연결된 카카오톡 채널 목록을 변경합니다.
DELETE	특정 앱과 카카오톡 채널의 연결을 해제합니다.
DELETE_ALL	앱과 연결된 여러 개의 카카오톡 채널을 연결 해제합니다.

FIND_ALL

앱과 연결된 카카오톡 채널 ID 목록을 조회합니다.

payload 하위의 dynamic에 대표 채널만 조회할지 여부를 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널의 ID 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
dynamic	`Boolean`	대표 채널만 조회할지 여부 `true`: 대표 채널을 포함한 전체 채널 목록 조회 `false`: 대표 채널만 조회 (기본값: `false`)	X

응답 페이로드

카카오톡 채널 ID(Int) 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL",
        "payload": {
            "dynamic": false
        }
    }'

응답 예제

// HTTP/2 200
[12345, 23445]

FIND_ALL_KAKAO_TALK_CHANNEL
Internal

앱과 연결된 카카오톡 채널 정보 목록을 조회합니다.

payload 하위의 dynamic에 대표 채널만 조회할 것인지 여부를 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널 정보 목록을 포함합니다. 앱과 연결된 카카오톡 채널 ID가 유효하지 않은 경우, 해당 카카오톡 채널 정보는 응답에 포함되지 않습니다.

요청 페이로드

이름	타입	설명	필수
dynamic	`Boolean`	대표 채널만 조회할지 여부 `true`: 대표 채널을 포함한 전체 채널 목록 조회 `false`: 대표 채널만 조회 (기본값: `false`)	X

응답 페이로드

PlusFriend 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL_KAKAO_TALK_CHANNEL",
        "payload": {
            "dynamic": false
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "profile_id": 12345,
    "encoded_profile_id": "_xnLE",
    "uuid": "@12345",
    "profile_name": "Sample",
    "is_open": true,
    "is_blocked": false,
    "pf_url": "http://sandbox-pf.kakao.com/_xnLE"
  }
  // ...
]

ADD

앱에 카카오톡 채널을 연결합니다.

payload 하위의 channel_id에 추가할 카카오톡 채널 ID를 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널 ID 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
channel_id	`Int`	카카오톡 채널 ID	O
dynamic	`Boolean`	대표 채널로 설정할지 여부 `true`: 대표 채널로 설정하지 않음 `false`: 대표 채널로 설정 (기본값: `false`)	X

응답 페이로드

카카오톡 채널 ID(Int) 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "ADD",
        "payload": {
            "channel_id": 99999
        }
    }'

응답 예제

// HTTP/2 200
[99999]

ADD_ALL

앱에 여러 개의 카카오톡 채널을 연결합니다.

payload 하위의 channel_id에 추가할 카카오톡 채널 ID 배열을 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널 ID 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
channel_id	`Int[]`	카카오톡 채널 ID	O
dynamic	`Boolean`	대표 채널로 설정할지 여부 ADD_ALL 요청 시, `dynamic`의 설정이 추가될 모든 카카오톡 채널에 동일하게 적용됨 `true`: 대표 채널로 설정하지 않음 `false`: 대표 채널로 설정 (기본값: `false`)	X

응답 페이로드

카카오톡 채널 ID(Int) 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "ADD_ALL",
        "payload": {
            "channel_id": [123456789,234567890]
        }
    }'

응답 예제

// HTTP/2 200
[123456789, 234567890]

UPDATE

앱과 연결된 카카오톡 채널을 변경합니다. 이 액션은 앱과 연결된 카카오톡 채널 중 하나를 특정해 다른 카카오톡 채널로 변경할 때 사용합니다.

payload 하위의 channel_id에 기존 카카오톡 채널 ID, new_channel_id에 변경할 카카오톡 채널 ID를 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널 ID 목록을 포함합니다. 기존 카카오톡 채널 ID가 올바르지 않으면 요청 처리에 실패합니다.

요청 페이로드

이름	타입	설명	필수
channel_id	`Int`	기존 카카오톡 채널 ID	O
new_channel_id	`Int`	변경할 카카오톡 채널 ID	O
dynamic	`Boolean`	대표 채널로 설정할지 여부 `true`: 대표 채널로 설정하지 않음 `false`: 대표 채널로 설정 (기본값: `false`)	X

응답 페이로드

카카오톡 채널 ID(Int) 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "channel_id": 19870111,
            "new_channel_id": 789789789
        }
    }'

응답 예제

// HTTP/2 200
[789789789]

UPDATE_ALL

앱과 연결된 카카오톡 채널 목록을 변경합니다. 이 액션은 앱과 연결된 카카오톡 채널 목록 전체를 변경할 때 사용합니다.

payload 하위의 channel_id에 변경할 카카오톡 채널 ID 목록을 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널 ID 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
channel_id	`Int[]`	카카오톡 채널 ID	O
dynamic	`Boolean`	대표 채널로 설정할지 여부 UPDATE_ALL 요청 시, `dynamic`의 설정이 변경될 모든 카카오톡 채널에 동일하게 적용됨 `true`: 대표 채널로 설정하지 않음 `false`: 대표 채널로 설정 (기본값: `false`)	X

응답 페이로드

카카오톡 채널 ID(Int) 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE_ALL",
        "payload": {
            "channel_id": [123456789,234567890]
        }
    }'

응답 예제

// HTTP/2 200
[234567890, 123456789]

DELETE

특정 앱과 카카오톡 채널의 연결을 해제합니다.

payload 하위의 channel_id에 연결 해제할 카카오톡 채널 ID를 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널 ID 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
channel_id	`Int`	카카오톡 채널 ID	O
dynamic	`Boolean`	대표 채널로 설정할지 여부 `true`: 대표 채널로 설정하지 않음 `false`: 대표 채널로 설정 (기본값: `false`)	X

응답 페이로드

카카오톡 채널 ID(Int) 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "DELETE",
        "payload": {
            "channel_id": 123456789
        }
    }'

응답 예제

// HTTP/2 200
[]

DELETE_ALL

앱에 연결된 여러 개의 카카오톡 채널을 연결 해제합니다.

payload 하위의 channel_id에 연결 해제할 카카오톡 채널 ID 목록을 전달합니다.

요청 처리 성공 시 응답은 payload에 앱과 연결된 카카오톡 채널 ID 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
channel_id	`Int[]`	카카오톡 채널 ID	O

응답 페이로드

카카오톡 채널 ID(Int) 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/kakaoTalkChannel" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "DELETE_ALL",
        "payload": {
            "channel_id": [123456789]
        }
    }'

응답 예제

// HTTP/2 200
[]

동의항목

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/scope`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL	앱에 설정 가능한 동의항목 목록을 조회합니다.
FIND	앱에 설정 가능한 특정 동의항목 정보를 조회합니다.
UPDATE	앱의 특정 동의항목 설정을 변경합니다.

FIND_ALL

앱에 설정 가능한 동의항목 목록을 조회합니다.

요청 처리 성공 시 응답은 앱에 설정 가능한 동의항목 목록을 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

AppScope 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/scope" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL"
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": 1159100,
    "id": "profile_nickname",
    "code": 2,
    "scope_type": "PRIVACY",
    "display_ko": "닉네임",
    "display_en": "Nickname",
    "purpose": ".",
    "level": "REQUIRED",
    "category": "NORMAL",
    "collecting": false
  }
  // ...
]

FIND

특정 동의항목 정보를 조회합니다. 이 액션은 조회 대상 앱에 설정할 수 없는 동의항목의 정보도 제공합니다.

payload 하위의 id에 정보를 조회할 동의항목 ID를 전달합니다.

요청 처리 성공 시 응답은 payload에 해당 동의항목 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
id	`String`	동의항목 ID	O

응답 페이로드

AppScope

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/scope" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND",
        "payload": {
            "id":"account_email"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 977071,
  "id": "account_email",
  "code": 10,
  "scope_type": "PRIVACY",
  "display_ko": "카카오계정(이메일)",
  "display_en": "Email",
  "purpose": ".",
  "level": "REQUIRED",
  "category": "NORMAL",
  "collecting": true
}

UPDATE

앱의 특정 동의항목 설정을 변경합니다.

payload 하위의 파라미터로 동의항목 변경 사항을 전달합니다.

요청 처리 성공 시 응답은 payload에 앱 ID와 변경된 동의항목 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
id	`String`	동의항목 ID	O
purpose	`String`	동의 목적	O
level	`String`	동의 단계, 아래 중 하나 `REQUIRED`: 필수 `OPTIONAL`: 선택 `LAZY`: 이용 중 동의 `NONE`: 사용 안함	O
collecting	`Boolean`	카카오계정으로 수집 후 제공 사용 여부 `true`: 사용 `false`: 사용 안함 (기본값: `false`)	X

응답 페이로드

AppScope

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/scope" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "id": "gender",
            "purpose": "test",
            "level": "OPTIONAL",
            "collecting": false
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159100,
  "id": "gender",
  "code": 12,
  "scope_type": "PRIVACY",
  "display_ko": "성별",
  "display_en": "Gender",
  "purpose": "test",
  "level": "OPTIONAL",
  "category": "NORMAL",
  "collecting": false
}

동의항목 정보 관리

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.
scope_code 부분에 동의항목 코드를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/scope/:scope_code`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND Internal	앱의 특정 동의항목 정보를 조회합니다.
UPDATE Internal	앱의 특정 동의항목 설정을 변경합니다.

FIND
Internal

앱의 특정 동의항목 정보를 조회합니다.

요청 처리 성공 시 응답은 payload에 해당 동의항목 정보를 포함합니다.

요청 페이로드

없음

응답 페이로드

AppScope

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/scope/:scope_code" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159100,
  "id": "gender",
  "code": 12,
  "scope_type": "PRIVACY",
  "display_ko": "성별",
  "display_en": "Gender",
  "purpose": "test",
  "level": "OPTIONAL",
  "category": "NORMAL",
  "collecting": false
}

UPDATE
Internal

앱의 특정 동의항목 설정을 변경합니다.

payload 하위의 파라미터로 동의항목 변경 사항을 전달합니다.

요청 처리 성공 시 응답은 payload에 앱 ID와 변경된 동의항목 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
purpose	`String`	동의 목적	O
level	`String`	동의 단계, 아래 중 하나 `REQUIRED`: 필수 `OPTIONAL`: 선택 `LAZY`: 이용 중 동의 `NONE`: 사용 안함	O
collecting	`Boolean`	카카오계정으로 수집 후 제공 사용 여부 `true`: 사용 `false`: 사용 안함 (기본값: `false`)	X

응답 페이로드

AppScope

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/scope/:scope_code" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "purpose": "test",
            "level": "LAZY"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159100,
  "id": "gender",
  "code": 12,
  "scope_type": "PRIVACY",
  "display_ko": "성별",
  "display_en": "Gender",
  "purpose": "test",
  "level": "LAZY",
  "category": "NORMAL",
  "collecting": false
}

Client Secret

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/oauth/clientSecret`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL Internal	앱에 등록된 모든 Client Secret 정보를 조회합니다.
FIND	앱의 Client Secret 정보를 조회합니다.
UPDATE	앱의 Client Secret 코드를 변경합니다.
UPDATE_STATUS	앱의 Client Secret 활성화 상태를 변경합니다.
DELETE	앱의 Client Secret을 삭제합니다.

FIND_ALL
Internal

앱에 등록된 모든 Client Secret 정보를 조회합니다. 각 앱은 하나의 Client Secret만 사용할 수 있으나, Client Secret을 재발급한 경우에는 2개 이상의 Client Secret 정보가 조회될 수 있습니다.

요청 처리 성공 시 응답은 payload에 앱의 Client Secret 목록을 포함합니다. Client Secret을 사용하도록 설정되지 않은 앱인 경우, 빈 배열을 포함합니다.

요청 페이로드

없음

응답 페이로드

ClientSecret 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/clientSecret" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 212,
    "app_id": 977072,
    "client_secret": "${CLIENT_SECRET_CODE}",
    "created_at": "2023-02-27T05:54:45Z"
  },
  {
    "id": 213,
    "app_id": 977072,
    "client_secret": "${CLIENT_SECRET_CODE}",
    "created_at": "2023-02-27T05:55:12Z"
  },
  {
    "id": 214,
    "app_id": 977072,
    "client_secret": "${CLIENT_SECRET_CODE}",
    "created_at": "2023-02-27T05:56:25Z"
  }
]

FIND

앱의 Client Secret 정보를 조회합니다. Client Secret은 Client Secret 활성화 상태가 사용(true)이고 코드(client_secret) 값이 존재하는 경우에만 적용됩니다.

요청 처리 성공 시 응답은 payload에 앱의 Client Secret 정보를 포함합니다.

요청 페이로드

없음

응답 페이로드

ClientSecretApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/clientSecret" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 977072,
  "active": false,
  "client_secret": "${CLIENT_SECRET_CODE}"
}

UPDATE

앱의 Client Secret 코드를 변경합니다. Client Secret 코드는 임의의 난수 값으로 생성되지만, 이 액션을 사용해 원하는 값으로 변경할 수 있습니다.

payload 하위의 client_secret 파라미터로 변경할 Client Secret 코드 값을 전달합니다. client_secret 파라미터 미사용 시, Client Secret 코드는 임의의 난수 값으로 변경됩니다.

요청 처리 성공 시 응답은 payload에 앱의 변경된 Client Secret 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
client_secret	`String`	Client Secret 코드 (최소: 8자, 최대: 32자) 파라미터 미사용 시 임의의 난수 값으로 변경됨	X

응답 페이로드

ClientSecretApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/clientSecret" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "client_secret": "${CLIENT_SECRET_CODE}"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 977072,
  "active": false,
  "client_secret": "${CLIENT_SECRET_CODE}"
}

UPDATE_STATUS

앱의 Client Secret 활성화 상태를 변경합니다.

payload 하위의 active 파라미터로 Client Secret 활성화 상태를 전달합니다. active 파라미터 미사용 시 사용 안함(false)으로 변경됩니다.

요청 처리 성공 시 응답은 payload에 앱의 변경된 Client Secret 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
active	`Boolean`	Client Secret 활성화 상태 `true`: 사용 `false`: 사용안함 (기본값: `false`)	X

응답 페이로드

ClientSecretApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/clientSecret" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE_STATUS",
        "payload": {
            "active": false
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 977072,
  "active": false,
  "client_secret": "${CLIENT_SECRET_CODE}"
}

DELETE

앱의 Client Secret을 삭제합니다.

요청 처리 성공 시 응답은 payload에 앱 ID와 함께 Client Secret 활성화 상태를 사용안함(false) 값으로 포함합니다.

요청 페이로드

없음

응답 페이로드

ClientSecretApp

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/clientSecret" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "DELETE"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 977072,
  "active": false
}

개인정보 국외이전

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/oauth/foreign`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL	앱의 개인정보 국외이전 설정을 조회합니다.
CREATE	앱에 개인정보 국외이전 설정을 추가합니다.

FIND_ALL

앱의 개인정보 국외이전 설정을 조회합니다.

요청 처리 성공 시 응답은 payload에 개인정보 국외이전 정보 목록을 포함합니다.

요청 페이로드

없음

응답 페이로드

Foreign 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/foreign" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 22684,
    "app_id": 977072,
    "country": "독일",
    "company": "ABC DataCenter",
    "manager": "-",
    "contact": "contact@abcdatacenter.com",
    "created_at": "2023-02-28T06:38:01Z",
    "updated_at": "2023-02-28T06:38:01Z"
  }
]

CREATE

앱에 개인정보 국외이전 설정을 추가합니다. 개인정보 국외이전 정보는 앱마다 여러 개 등록될 수 있습니다.

payload 하위의 파라미터에 개인정보 국외이전 정보를 전달해야 합니다.

요청 처리 성공 시 응답은 payload에 추가된 개인정보 국외이전 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
country	`String`	개인정보가 국외이전되는 국가	O
company	`String`	개인정보를 국외이전 받는 사업자	O
contact	`String`	개인정보를 국외이전 받는 사업자의 연락처(이메일)	O

응답 페이로드

Foreign

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/foreign" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "CREATE",
        "payload": {
            "country": "미국",
            "company": "ABC Data Center",
            "contact": "john@abcdatacenter.com"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 22688,
  "app_id": 977072,
  "country": "미국",
  "company": "ABC Data Center",
  "manager": "-",
  "contact": "john@abcdatacenter.com",
  "created_at": "2023-03-02T03:24:19Z",
  "updated_at": "2023-03-02T03:24:19Z"
}

개인정보 국외이전 동의항목

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.
:id 부분에 개인정보 국외이전 정보 동의항목 ID를 입력해야 합니다. 개인정보 국외이전의 FIND_ALL로 개별 동의항목 ID를 확인할 수 있습니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/oauth/foreign/:id`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND	앱의 개인정보 국외이전 동의항목을 조회합니다.
UPDATE	앱의 개인정보 국외이전 동의항목 정보를 변경합니다.
DELETE	앱의 개인정보 국외이전 동의항목을 삭제합니다.

FIND

앱의 개인정보 국외이전 동의항목을 조회합니다. 앱에 등록된 각 개인정보 국외이전 정보는 동의항목으로써 카카오 로그인 시 사용자에게 동의받아야 합니다. (참고: 개인정보 국외이전)

요청 처리 성공 시 응답은 payload에 개인정보 국외이전 동의항목의 정보를 포함합니다.

요청 페이로드

없음

응답 페이로드

Foreign

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/foreign/:id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "id": 22687,
  "app_id": 977072,
  "country": "미국",
  "company": "ABC Data Center",
  "manager": "-",
  "contact": "john@abcdatacenter.com",
  "created_at": "2023-03-02T03:23:45Z",
  "updated_at": "2023-03-02T03:23:45Z"
}

UPDATE

앱의 개인정보 국외이전 동의항목 정보를 변경합니다.

payload 하위 파라미터에 개인정보 국외이전 동의항목의 변경 사항을 전달합니다. 변경하지 않을 항목도 기존 값으로 전달해야 합니다.

요청 처리 성공 시 응답은 payload에 변경된 개인정보 국외이전 동의항목 정보를 변경합니다.

요청 페이로드

이름	타입	설명	필수
country	`String`	개인정보가 국외이전되는 국가	O
company	`String`	개인정보를 국외이전 받는 사업자	O
contact	`String`	개인정보를 국외이전 받는 사업자의 연락처(이메일)	O

응답 페이로드

Foreign

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/foreign/:id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "country": "영국",
            "company": "Data Center",
            "contact": "smith@abcdatacenter.com"
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 22689,
  "app_id": 1159109,
  "country": "영국",
  "company": "Data Center",
  "manager": "-",
  "contact": "smith@abcdatacenter.com",
  "created_at": "2023-03-02T03:25:14Z",
  "updated_at": "2023-03-02T04:54:19Z"
}

DELETE

앱의 개인정보 국외이전 동의항목을 삭제합니다.

요청 처리 성공 시 응답은 payload에 삭제된 개인정보 국외이전 동의항목 정보를 포함합니다.

요청 페이로드

없음

응답 페이로드

Foreign

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/foreign/:id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "DELETE"
    }'

응답 예제

// HTTP/2 200
{
  "id": 22689,
  "app_id": 1159109,
  "country": "영국",
  "company": "Data Center",
  "manager": "-",
  "contact": "smith@abcdatacenter.com",
  "created_at": "2023-03-02T03:25:14Z",
  "updated_at": "2023-03-02T04:54:58Z"
}

보안 이벤트 구독

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/oauth/sseConfig`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND	앱의 보안 이벤트 구독 설정을 조회합니다.
CREATE	앱에 보안 이벤트 구독을 설정합니다.
UPDATE	앱의 보안 이벤트 구독 설정을 변경합니다.
DELETE	앱의 보안 이벤트 구독 설정을 삭제합니다.

FIND

앱의 보안 이벤트 구독 설정을 조회합니다.

요청 처리 성공 시 응답은 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

SSEConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/sseConfig" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159110,
  "status": "ENABLED",
  "sub_events": [7, 8],
  "method": "PUSH",
  "push_url": "https://sample.com/sse",
  "created_at": "2023-07-17T02:45:19Z",
  "updated_at": "2023-07-17T02:45:19Z"
}

응답 예제: 보안 이벤트 구독 미사용 앱

// HTTP/2 404
{
  "message": "Failed to find the SSEConfig: 1159109"
}

CREATE

앱에 보안 이벤트 구독을 설정합니다.

payload 하위 파라미터에 보안 이벤트 구독 설정을 전달해야 합니다.

요청 처리 성공 시 응답은 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
status	`SSEClientStatus`	보안 이벤트 구독 설정 상태	O
sub_events	`SSEventType[]`	구독 중인 보안 이벤트 타입	X
method	`String`	보안 이벤트 전달 메서드, 아래 중 하나 `PUSH` `POLL`	X
push_url	`String`	보안 이벤트 전달 URL	X

응답 페이로드

SSEConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/sseConfig" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "CREATE",
        "payload": {
            "status": "ENABLED",
            "sub_events": [7, 8],
            "push_url": "https://sample.com/sse"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159110,
  "status": "ENABLED",
  "sub_events": [7, 8],
  "push_url": "https://sample.com/sse",
  "created_at": "2023-07-17T03:22:45Z",
  "updated_at": "2023-07-17T03:22:45Z"
}

UPDATE

앱의 보안 이벤트 구독 설정을 변경합니다.

payload 하위 파라미터에 보안 이벤트 구독 설정을 전달해야 합니다.

요청 처리 성공 시 응답은 payload에 보안 이벤트 구독 설정을 포함합니다.

요청 페이로드

이름	타입	설명	필수
status	`SSEClientStatus`	보안 이벤트 구독 설정 상태	O
sub_events	`SSEventType[]`	구독 중인 보안 이벤트 타입	X
method	`String`	보안 이벤트 전달 메서드, 아래 중 하나 `PUSH` `POLL`	X
push_url	`String`	보안 이벤트 전달 URL	X

응답 페이로드

SSEConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/sseConfig" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "status": "DISABLED",
            "sub_events": [7, 8, 9],
            "push_url": "https://sample.com/sse"
        }
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159110,
  "status": "DISABLED",
  "sub_events": [7, 8, 9],
  "push_url": "https://sample.com/sse",
  "created_at": "2023-07-17T03:23:29Z",
  "updated_at": "2023-07-17T03:33:12Z"
}

DELETE

앱의 보안 이벤트 구독 설정을 삭제합니다.

요청 처리 성공 시 응답은 payload에 삭제된 보안 이벤트 구독 설정을 포함합니다.

요청 페이로드

없음

응답 페이로드

SSEConfig

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/sseConfig" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "DELETE"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1159110,
  "status": "ENABLED",
  "sub_events": [7, 8],
  "method": "PUSH",
  "push_url": "https://sample.com/sse",
  "created_at": "2023-07-17T02:45:19Z",
  "updated_at": "2023-07-17T02:45:19Z"
}

1회성 제공 동의

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/oauth/plugin`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL	앱의 1회성 제공 동의 설정을 조회합니다.
FIND	앱의 특정 1회성 제공 동의 설정을 조회합니다.
CREATE	앱에 1회성 제공 동의을 설정합니다.
UPDATE	앱의 특정 1회성 제공 동의 설정을 변경합니다.
DELETE	앱의 특정 1회성 제공 동의 설정을 삭제합니다.

FIND_ALL

앱의 1회성 제공 동의 설정을 조회합니다.

요청 처리 성공 시 응답은 payload에 앱에 설정된 1회성 제공 동의 목록을 포함합니다.

요청 페이로드

없음

응답 페이로드

ApplicationPlugin 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/plugin" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 56,
    "app_id": 1134530,
    "plugin": "DEFAULT",
    "extra_id": 0,
    "purpose": "NONE",
    "required_scopes": [2, 3, 10, 12, 19],
    "optional_scopes": [],
    "collecting_scopes": [],
    "token_ttl": 1200,
    "created_at": "2021-10-01T05:36:42Z",
    "updated_at": "2021-10-06T01:45:44Z"
  }
]

FIND

앱의 특정 1회성 제공 동의 설정을 조회합니다.

payload 하위 plugin 파라미터에 조회할 1회성 제공 동의의 타입을 전달해야 합니다. SURVEY, QR 타입의 1회성 제공 동의는 extra_id 값을 정확히 입력해야 조회 가능합니다. 이 외 타입의 1회성 제공 동의는 extra_id 값을 0으로 지정합니다.

요청 처리 성공 시 응답은 payload에 plugin에 지정한 타입과 extra_id 조건을 만족하는 앱의 1회성 제공 동의 설정을 포함합니다.

요청 페이로드

이름	타입	설명	필수
plugin	`String`	1회성 제공 동의 타입	O
extra_id	`Int`	`SURVEY`, `QR` 타입 1회성 제공 동의의 확장 키 다른 타입의 1회성 제공 동의 조회 시에는 `0` 값으로 요청	O

응답 페이로드

ApplicationPlugin

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/plugin" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "id": 56,
  "app_id": 1134530,
  "plugin": "DEFAULT",
  "extra_id": 0,
  "purpose": "NONE",
  "required_scopes": [2, 3, 10, 12, 19],
  "optional_scopes": [],
  "collecting_scopes": [],
  "token_ttl": 1200,
  "created_at": "2021-10-01T05:36:42Z",
  "updated_at": "2021-10-06T01:45:44Z"
}

CREATE

앱에 1회성 제공 동의를 설정합니다.

payload 하위의 파라미터에 1회성 제공 동의 정보를 전달합니다. SURVEY, QR 타입 외 1회성 제공 동의는 타입별로 하나씩만 등록할 수 있습니다. 동의항목의 경우, 앱에 설정 권한이 없다면 사용할 수 없습니다.

요청 처리 성공 시 응답은 payload에 설정된 1회성 제공 동의 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
plugin	`PluginType`	1회성 제공 동의 타입	O
extra_id	`Int`	`SURVEY`, `QR` 타입 1회성 제공 동의의 확장 키(최소: 1)	O
extra_type	`String`	1회성 플러그인 확장 타입(최대: 32자)	X
name	`String`	1회성 제공 동의 설정 이름	X
purpose	`PluginPurpose`	1회성 제공 동의 사용 목적(기본값: `NONE`)	O
required_scopes	`Int[]`	필수 동의항목 목록	O
optional_scopes	`Int[]`	선택 동의항목 목록	O
collecting_scopes	`Int[]`	수집 후 제공 동의항목 목록	O
token_ttl	`Int`	토큰 만료 시간(최소: 0)	O

응답 페이로드

ApplicationPlugin

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/plugin" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "CREATE",
        "payload": {
            "plugin": "DEFAULT",
            "extra_id": 0,
            "extra_type": "NONE",
            "name": "1회성제공동의예제",
            "purpose": "NONE",
            "required_scopes": [5, 10],
            "optional_scopes": [],
            "collecting_scopes": [10],
            "token_ttl": 1200
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 68,
  "app_id": 977072,
  "plugin": "DEFAULT",
  "extra_id": 0,
  "extra_type": "NONE",
  "name": "1회성제공동의예제",
  "purpose": "NONE",
  "required_scopes": [5, 10],
  "optional_scopes": [],
  "collecting_scopes": [10],
  "token_ttl": 1200,
  "created_at": "2023-03-02T08:40:56Z",
  "updated_at": "2023-03-02T08:40:56Z"
}

UPDATE

앱의 특정 1회성 제공 동의 설정을 변경합니다.

payload 하위 파라미터로 변경할 1회성 제공 동의 설정을 전달해야 합니다.

요청 처리 성공 시 응답은 payload에 변경된 1회성 제공 동의 설정을 포함합니다.

요청 페이로드

이름	타입	설명	필수
plugin	`PluginType`	1회성 제공 동의 타입	O
extra_id	`Int`	`SURVEY`, `QR` 타입 1회성 제공 동의의 확장 키(최소: 1)	O
extra_type	`String`	1회성 플러그인 확장 타입(최대: 32자)	X
name	`String`	1회성 제공 동의 설정 이름	X
purpose	`PluginPurpose`	1회성 제공 동의 사용 목적(기본값: `NONE`)	O
required_scopes	`Int[]`	필수 동의항목 목록	O
optional_scopes	`Int[]`	선택 동의항목 목록	O
collecting_scopes	`Int[]`	수집 후 제공 동의항목 목록	O
token_ttl	`Int`	토큰 만료 시간(최소: 0)	O

응답 페이로드

ApplicationPlugin

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/plugin" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "plugin": "DEFAULT",
            "extra_id": 0,
            "extra_type": "NONE",
            "name": "1회성제공동의예제",
            "purpose": "NONE",
            "required_scopes": [5, 10],
            "optional_scopes": [12],
            "collecting_scopes": [10],
            "token_ttl": 1200
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 70,
  "app_id": 977072,
  "plugin": "DEFAULT",
  "extra_id": 0,
  "extra_type": "NONE",
  "name": "1회성제공동의예제",
  "purpose": "NONE",
  "required_scopes": [5, 10],
  "optional_scopes": [12],
  "collecting_scopes": [10],
  "token_ttl": 1200,
  "created_at": "2023-03-02T08:42:22Z",
  "updated_at": "2023-03-02T08:44:20Z"
}

DELETE

앱의 특정 1회성 제공 동의 설정을 삭제합니다.

payload 하위 plugin에 삭제할 1회성 제공 동의 타입, extra_id에 1회성 제공 동의 ID를 지정해야 합니다.

요청 처리 성공 시 응답은 payload에 삭제된 1회성 제공 동의 설정을 포함합니다.

요청 페이로드

없음

응답 페이로드

ApplicationPlugin

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/oauth/plugin" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "DELETE"
    }'

응답 예제

// HTTP/2 200
{
  "id": 70,
  "app_id": 977072,
  "plugin": "DEFAULT",
  "extra_id": 0,
  "extra_type": "NONE",
  "name": "1회성제공동의예제",
  "purpose": "NONE",
  "required_scopes": [5, 10],
  "optional_scopes": [12],
  "collecting_scopes": [10],
  "token_ttl": 1200,
  "created_at": "2023-03-02T08:42:22Z",
  "updated_at": "2023-03-02T08:44:46Z"
}

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

내 애플리케이션: 카카오 로그인

제목 태그

카카오 로그인 기본 설정

요청

액션

FIND

요청 페이로드

응답 페이로드

요청 예제

응답 예제

FIND_STATUS

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE_STATUS

요청 페이로드

응답 페이로드

요청 예제

응답 예제

ADD_REDIRECT_URI

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE_REDIRECT_URI

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE_LOGOUT_REDIRECT_URI

요청 페이로드

응답 페이로드

요청 예제

응답 예제

카카오 로그인 추가 설정

요청

액션

FINDInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATEInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE_AUTO_REGISTER_ON_LOGINInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE_KEEP_USER_IDInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE_NOT_ALLOWED_UNDER_AGE14Internal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

카카오톡 채널

요청

액션

FIND_ALL

요청 페이로드

FIND
Internal

UPDATE
Internal

UPDATE_AUTO_REGISTER_ON_LOGIN
Internal

UPDATE_KEEP_USER_ID
Internal

UPDATE_NOT_ALLOWED_UNDER_AGE14
Internal

FIND_ALL_KAKAO_TALK_CHANNEL
Internal

FIND
Internal

UPDATE
Internal