내 애플리케이션: 사용자

신규 어드민 API 제공

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

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

제목 태그

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

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

사용자 조회

요청

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

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

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

액션

이름	설명
FIND_ALL Internal	특정 회원번호에 해당하는 앱 사용자 목록을 가져옵니다.
FIND_ALL_BY_ACCOUNT_ID Internal	특정 카카오계정 ID에 해당하는 앱 사용자 목록을 가져옵니다.
FIND_ALL_REGISTERED_AS_DEVELOPER Internal	앱의 팀원으로 등록된 사용자 목록을 가져옵니다.
FIND_BY_ACCOUNT_ID Internal	특정 카카오계정 ID에 해당하는 사용자를 조회합니다.

FIND_ALL
Internal

특정 회원번호에 해당하는 앱 사용자 목록을 가져옵니다. 이 API는 전체 사용자 목록을 제공하지 않으며, 조회할 사용자 회원번호 목록을 지정해 요청해야 합니다.

요청 처리 성공 시 응답은 payload에 앱 사용자 정보 목록을 포함합니다. 요청 시 payload에 사용자 회원번호 목록을 전달하지 않았거나, 전달된 회원번호에 해당하는 사용자가 없는 경우 payload에 빈 배열을 반환합니다.

요청 페이로드

이름	타입	설명	필수
id	`Long`	조회할 앱 사용자 회원번호 목록(최대: 1000)	O

응답 페이로드

User 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": {
            "id": [1376016924429759243,1376016924429850721]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 1376016924429759243,
    "app_id": 977071,
    "account_type": "KAKAO",
    "account_id": "2137162",
    "status": "REGISTERED",
    "registered_at": "2021-12-22T10:38:08Z",
    "app_scopes": [4, 5, 6, 10, 19, 24, 25, 27, 30, 33, 37, 38],
    "updated_at": "2021-12-22T10:38:08Z"
  }
  // ...
]

응답 예제: 전달된 회원번호에 해당하는 사용자 없음

// HTTP/2 200
[]

FIND_ALL_BY_ACCOUNT_ID
Internal

특정 회원번호에 해당하는 앱 사용자 목록을 가져옵니다. 한 명의 사용자만 조회 요청할 때는 이 액션이 아닌 FIND_BY_ACCOUNT_ID 액션을 사용해야 합니다.

요청 처리 성공 시 응답은 payload에 앱 사용자 정보 목록을 포함합니다. 요청 시 payload에 사용자 회원번호 목록을 전달하지 않았거나, 전달된 카카오계정 ID에 해당하는 사용자가 없는 경우 payload에 빈 배열을 반환합니다.

요청 페이로드

이름	타입	설명	필수
account_id	`Long`	조회할 앱 사용자 카카오계정 ID 목록(최대: 1000)	O

응답 페이로드

User 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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_BY_ACCOUNT_ID",
        "payload": {
            "account_id": [2137162]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 1376016924429759243,
    "app_id": 977071,
    "account_type": "KAKAO",
    "account_id": "2137162",
    "status": "REGISTERED",
    "registered_at": "2021-12-22T10:51:18Z",
    "app_scopes": [4, 5, 6, 10, 19, 24, 25, 27, 30, 33, 37, 38],
    "updated_at": "2021-12-22T10:51:18Z"
  }
]

응답 예제: 전달된 카카오계정 ID에 해당하는 사용자 없음

// HTTP/2 200
[]

FIND_ALL_REGISTERED_AS_DEVELOPER
Internal

앱 사용자 중 멤버로 등록된 사용자 목록을 가져옵니다.

요청 처리 성공 시 응답은 payload에 팀원인 사용자 목록을 포함합니다.

요청 페이로드

없음

응답 페이로드

User 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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_REGISTERED_AS_DEVELOPER"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 1376016924429759243,
    "app_id": 977071,
    "account_type": "KAKAO",
    "account_id": "2137162",
    "status": "REGISTERED",
    "registered_at": "2021-12-22T10:51:18Z",
    "app_scopes": [4, 5, 6, 10, 19, 24, 25, 27, 30, 33, 37, 38],
    "updated_at": "2021-12-22T10:51:18Z"
  }
  // ...
]

FIND_BY_ACCOUNT_ID
Internal

특정 카카오계정 ID에 해당하는 사용자를 조회합니다.

요청 처리 성공 시 응답은 payload에 카카오계정 ID에 해당하는 사용자 정보를 포함합니다.

요청 페이로드

이름	타입	설명	필수
account_id	`Long`	조회할 앱 사용자 카카오계정 ID	O

응답 페이로드

User

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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_BY_ACCOUNT_ID",
        "payload": {
            "account_id": 2137162
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 1376016924429759243,
  "app_id": 977071,
  "account_type": "KAKAO",
  "account_id": "2137162",
  "status": "REGISTERED",
  "registered_at": "2021-12-22T10:51:18Z",
  "app_scopes": [4, 5, 6, 10, 19, 24, 25, 27, 30, 33, 37, 38],
  "updated_at": "2021-12-22T10:51:18Z"
}

응답 예제: 조회 실패

// HTTP/2 404
{
  "message": "${MESSAGE}"
}

사용자 ID 변환

요청

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

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

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

액션

이름	설명
CONVERT_FROM_APP_USER_ID	회원번호로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.
CONVERT_FROM_ACCOUNT_ID	카카오계정 ID로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.
CONVERT_FROM_TALK_USER_ID	카카오톡 회원번호로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.
CONVERT_FROM_ACCESS_TOKEN	액세스 토큰으로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.
CONVERT_FROM_REFRESH_TOKEN	리프레시 토큰으로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.
CONVERT_FROM_FRIEND_UUID	고유 ID로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.
CONVERT_FROM_EMAIL	이메일로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.

CONVERT_FROM_APP_USER_ID

회원번호로 앱 ID나 다른 타입의 사용자 ID를 조회합니다. 한 번에 여러 사용자 회원번호를 전달해 요청할 수 있습니다.

요청 처리 성공 시 응답은 payload에 요청 시 지정한 ID 타입의 키와 값으로 구성된 배열을 포함합니다.

요청 페이로드

이름	타입	설명	필수
id	`Long[]`	회원번호 목록	O
to	`String[]`	조회할 다른 타입 ID, 아래 중 하나 `app_id`: 앱 ID `app_user_id`: 회원번호 `account_id`: 카카오계정 ID `talk_user_id`: 카카오톡 회원번호 `email`: 카카오계정 이메일 `display_id`: 대표 정보 중요: `email`은 API플랫폼 내부 전용	O

응답 페이로드

요청 시 지정한 ID 타입의 키와 값으로 구성된 배열
IdType 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": "CONVERT_FROM_APP_USER_ID",
        "payload": {
            "id": [1376016924429759243],
            "to": ["app_id","account_id","display_id"]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": "977071",
    "account_id": "2137162",
    "display_id": "sample@kakao.com"
  }
]

CONVERT_FROM_ACCOUNT_ID

카카오계정 ID로 앱 ID나 다른 타입의 사용자 ID를 조회합니다. 한 번에 여러 사용자 회원번호를 전달해 요청할 수 있습니다.

요청 처리 성공 시 응답은 payload에 요청 시 지정한 ID 타입의 키와 값으로 구성된 배열을 포함합니다. 회원번호, 앱 ID는 앱에 연결 또는 연결 대기 상태인 사용자인 경우에만 응답에 포함됩니다.

요청 페이로드

이름	타입	설명	필수
id	`Long[]`	카카오계정 ID 목록	O
to	`String[]`	조회할 다른 타입 ID, 아래 중 하나 `app_id`: 앱 ID `app_user_id`: 회원번호 `account_id`: 카카오계정 ID `talk_user_id`: 카카오톡 회원번호 `email`: 카카오계정 이메일 `display_id`: 대표 정보 중요: `email`은 API플랫폼 내부 전용	O

응답 페이로드

요청 시 지정한 ID 타입의 키와 값으로 구성된 배열
IdType 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": "CONVERT_FROM_ACCOUNT_ID",
        "payload": {
            "id": [2137162],
            "to": ["app_id","app_user_id","display_id"]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": "977071",
    "app_user_id": "1376016924429759243",
    "display_id": "sample@kakaocorp.com"
  }
]

CONVERT_FROM_TALK_USER_ID

카카오톡 회원번호로 앱 ID나 다른 타입의 사용자 ID를 조회합니다. 한 번에 여러 사용자 회원번호를 전달해 요청할 수 있습니다.

요청 페이로드

이름	타입	설명	필수
id	`Long[]`	카카오톡 회원번호 목록	O
to	`String[]`	조회할 다른 타입 ID, 아래 중 하나 `app_id`: 앱 ID `app_user_id`: 회원번호 `account_id`: 카카오계정 ID `talk_user_id`: 카카오톡 회원번호 `email`: 카카오계정 이메일 `display_id`: 대표 정보 중요: `email`은 API플랫폼 내부 전용	O

응답 페이로드

요청 시 지정한 ID 타입의 키와 값으로 구성된 배열
IdType 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": "CONVERT_FROM_TALK_USER_ID",
        "payload": {
            "id": [700119942],
            "to": ["app_id","app_user_id","account_id"]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": "977071",
    "app_user_id": "1376016924429759243",
    "account_id": "2137162"
  }
]

CONVERT_FROM_ACCESS_TOKEN

액세스 토큰으로 앱 ID나 다른 타입의 사용자 ID를 조회합니다. 한 번에 여러 사용자 회원번호를 전달해 요청할 수 있습니다.

요청 처리 성공 시 응답은 payload에 요청 시 지정한 ID 타입의 키와 값으로 구성된 배열을 포함합니다. 사용자의 액세스 토큰이 유효하지 않은 경우, 해당 사용자의 정보는 응답에서 제외됩니다.

요청 페이로드

이름	타입	설명	필수
token	`String[]`	액세스 토큰 목록	O
to	`String[]`	조회할 다른 타입 ID, 아래 중 하나 `app_id`: 앱 ID `app_user_id`: 회원번호 `account_id`: 카카오계정 ID `talk_user_id`: 카카오톡 회원번호 `email`: 카카오계정 이메일 `display_id`: 대표 정보 중요: `email`은 API플랫폼 내부 전용	O

응답 페이로드

요청 시 지정한 ID 타입의 키와 값으로 구성된 배열
IdType 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": "CONVERT_FROM_ACCESS_TOKEN",
        "payload": {
            "token": ["${ACCESS_TOKEN}"],
            "to": ["app_id","app_user_id"]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": "977071",
    "app_user_id": "1376016924429759243"
  }
]

CONVERT_FROM_REFRESH_TOKEN

리프레시 토큰으로 앱 ID나 다른 타입의 사용자 ID를 조회합니다. 한 번에 여러 사용자 회원번호를 전달해 요청할 수 있습니다.

요청 처리 성공 시 응답은 payload에 요청 시 지정한 ID 타입의 키와 값으로 구성된 배열을 포함합니다. 사용자의 리프레시 토큰이 유효하지 않은 경우, 해당 사용자의 정보는 응답에서 제외됩니다.

요청 페이로드

이름	타입	설명	필수
token	`String[]`	리프레시 토큰 목록	O
to	`String[]`	조회할 다른 타입 ID, 아래 중 하나 `app_id`: 앱 ID `app_user_id`: 회원번호 `account_id`: 카카오계정 ID `talk_user_id`: 카카오톡 회원번호 `email`: 카카오계정 이메일 `display_id`: 대표 정보 중요: `email`은 API플랫폼 내부 전용	O

응답 페이로드

요청 시 지정한 ID 타입의 키와 값으로 구성된 배열
IdType 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": "CONVERT_FROM_REFRESH_TOKEN",
        "payload": {
            "token": ["${REFRESH_TOKEN}"],
            "to": ["app_id","app_user_id"]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": "977071",
    "app_user_id": "1376016924429759243"
  }
]

CONVERT_FROM_FRIEND_UUID

고유 ID로 앱 ID나 다른 타입의 사용자 ID를 조회합니다. 한 번에 여러 사용자 회원번호를 전달해 요청할 수 있습니다.

요청 처리 성공 시 응답은 payload에 요청 시 지정한 ID 타입의 키와 값으로 구성된 배열을 포함합니다.

요청 페이로드

이름	타입	설명	필수
uuid	`Long[]`	고유 ID 목록	O
to	`String[]`	조회할 다른 타입 ID, 아래 중 하나 `app_id`: 앱 ID `app_user_id`: 회원번호 `account_id`: 카카오계정 ID `talk_user_id`: 카카오톡 회원번호 `email`: 카카오계정 이메일 `display_id`: 대표 정보 중요: `email`은 API플랫폼 내부 전용	O

응답 페이로드

요청 시 지정한 ID 타입의 키와 값으로 구성된 배열
IdType 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": "CONVERT_FROM_FRIEND_UUID",
        "payload": {
            "uuid": ["YlBhUmVUYlB8S3tLektyS39NYVhvWGhfbg0"],
            "to": ["app_id","app_user_id"]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": "977071",
    "app_user_id": "1376016924429759243"
  }
]

CONVERT_FROM_EMAIL
Internal

이메일로 앱 ID나 다른 타입의 사용자 ID를 조회합니다.

요청 처리 성공 시 응답은 payload에 요청 시 지정한 ID 타입의 키와 값으로 구성된 배열을 포함합니다.

요청 페이로드

이름	타입	설명	필수
email	`String[]`	이메일 목록(최대: 1,000개)	O
to	`String[]`	조회할 다른 타입 ID, 아래 중 하나 `app_id`: 앱 ID `app_user_id`: 회원번호 `account_id`: 카카오계정 ID `talk_user_id`: 카카오톡 회원번호 `email`: 카카오계정 이메일 `display_id`: 대표 정보	O

응답 페이로드

요청 시 지정한 ID 타입의 키와 값으로 구성된 배열
IdType 참고

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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": "CONVERT_FROM_EMAIL",
        "payload": {
            "email": ["sample@kakao.com","sample@kakaocorp.com"],
            "to": ["app_id","app_user_id"]
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "app_id": "977071",
    "app_user_id": "1376016924430764417"
  },
  {
    "app_id": "977071",
    "app_user_id": "1376016924429759243"
  }
]

사용자 및 사용자 프로퍼티

요청

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

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

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

액션

이름	설명
FIND_ALL_USER_AND_PROPERTY Internal	앱 사용자 및 사용자 프로퍼티 목록을 가져옵니다.
FIND_ALL_USER_AND_PROPERTY_REGISTERED_AS_DEVELOPER Internal	앱의 팀원으로 등록된 사용자 및 사용자 프로퍼티 목록을 가져옵니다.

FIND_ALL_USER_AND_PROPERTY
Internal

앱 사용자 및 사용자 프로퍼티 목록을 가져옵니다.

요청 처리 성공 시 응답은 payload에 각 사용자의 회원번호, 연결 시각, 연결 상태, 사용자 프로퍼티를 담은 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
ascending	`Boolean`	결과 목록 오름차순 정렬 여부 (기본값: `false`)	X
page_size	`Int`	한 페이지에 포함할 결과의 수 결과를 페이지 형태로 분할해 요청할 때 사용 (기본값: `50`)	X
page_index	`Int`	조회할 페이지 번호 `page_size`로 결과를 페이지 형태로 분할해 요청한 경우, 다른 페이지의 결과를 조회하기 위해 사용 (기본값: `0`, 최소: `0`)	X

응답 페이로드

이름	타입	설명	필수
from	`Int`	현재 응답의 페이지 번호 요청 시 `page_index`로 페이지를 지정해 요청한 경우, 해당 페이지 번호 (기본값: `0`)	X
size	`Int`	현재 응답에 포함되는 사용자 수의 최댓값 (기본값: `50`)	X
count	`Int`	현재 응답에 포함된 사용자 수	X
data	`UserResult[]`	각 사용자 정보 목록	X

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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_USER_AND_PROPERTY",
        "payload": {
            "ascending": true,
            "page_size": 100
        }
    }'

응답 예제

// HTTP/2 200
{
  "from": 0,
  "size": 100,
  "count": 1,
  "data": [
    {
      "id": 1376016924429759243,
      "registered_at": "2021-12-22T10:51:18Z",
      "status": "REGISTERED",
      "properties": {
        "${CUSTOM_PROPERTY_KEY}": "${CUSTOM_PROPERTY_VALUE}"
        // ...
      }
    }
  ]
}

FIND_ALL_USER_AND_PROPERTY_REGISTERED_AS_DEVELOPER
Internal

앱 사용자 중 멤버로 등록된 사용자 및 사용자 프로퍼티 목록을 가져옵니다.

요청 처리 성공 시 응답은 payload에 각 사용자의 회원번호, 연결 시각, 연결 상태, 사용자 프로퍼티를 담은 목록을 포함합니다.

요청 페이로드

없음

응답 페이로드

UserResult 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user" \
  -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_USER_AND_PROPERTY_REGISTERED_AS_DEVELOPER"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 1376016924429759243,
    "registered_at": "2021-12-22T12:56:50Z",
    "status": "REGISTERED",
    "properties": {
      "${CUSTOM_PROPERTY_KEY}": "${CUSTOM_PROPERTY_VALUE}"
      // ...
    }
  }
]

개별 사용자 조회

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.
:id 부분에 요청 대상 사용자 회원번호를 입력해야 합니다.

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

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

액션

이름	설명
FIND Internal	회원번호로 사용자를 조회합니다.
UPDATE Internal	사용자 정보를 수정합니다.

FIND
Internal

회원번호로 사용자를 조회합니다.

요청 처리 성공 시 응답은 payload에 사용자 정보를 포함합니다.

요청 페이로드

없음

응답 페이로드

User

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/: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": 1376016924429759243,
  "app_id": 977071,
  "account_type": "KAKAO",
  "account_id": "2137162",
  "status": "REGISTERED",
  "registered_at": "2021-12-22T10:51:18Z",
  "app_scopes": [4, 5, 6, 10, 19, 24, 25, 27, 30, 33, 37, 38],
  "updated_at": "2021-12-22T10:51:18Z"
}

응답 예제: 조회 실패

// HTTP/2 404
{
  "message": "${MESSAGE}"
}

UPDATE
Internal

사용자 정보를 수정합니다. 사용자의 앱 연결 상태, 연결 시각, 동의한 동의항목을 수정할 수 있습니다.

payload 하위 파라미터로 수정할 정보를 전달합니다.

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

요청 페이로드

이름	타입	설명	필수
account_id	`Long`	카카오계정 ID `account_id`는 이 액션으로 변경되지 않으며, 요청 대상을 특정하는 용도로 전달	O
account_type	`String`	계정 타입(기본값: `KAKAO`(카카오계정))	X
status	`String`	연결 상태 `REGISTERED`: 연결 `PREREGISTERED`: 연결 대기	O
registered_at	`Datetime`	연결 시각	X
app_scopes	`Int[]`	사용자가 동의한 동의항목 목록	X
agreement_code_ids	`Int[]`	앱별로 추가 설정된 기타 동의항목 중, 사용자가 동의한 동의항목 목록	X

응답 페이로드

User

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/: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": {
            "account_id": 2350171,
            "status": "REGISTERED",
            "registered_at": "2023-01-01T00:00:00Z",
            "app_scopes": [4,5,6,10]
        }
    }'

응답 예제

// HTTP/2 200
{
  "id": 1376016924430764417,
  "app_id": 977071,
  "account_type": "KAKAO",
  "account_id": "2350171",
  "status": "REGISTERED",
  "registered_at": "2023-01-01T00:00Z",
  "app_scopes": [4, 5, 6, 10],
  "updated_at": "2023-01-03T09:50:45Z"
}

사용자 프로퍼티 키

요청

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

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

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

액션

이름	설명
FIND_ALL Internal	앱의 사용자 프로퍼티 목록을 조회합니다.
ADD Internal	앱에 사용자 프로퍼티 키를 추가합니다.
REMOVE Internal	앱의 사용자 프로퍼티 키를 삭제합니다.

FIND_ALL
Internal

앱의 사용자 프로퍼티 키 목록을 조회합니다.

요청 처리 성공 시 응답은 payload에 사용자 프로퍼티 키 목록을 포함합니다.

요청 페이로드

없음

응답 페이로드

UserPropertyKey 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/propertyKey" \
  -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": 5147194,
    "app_id": 1159110,
    "name": "msg_blocked",
    "data_type": "STRING",
    "unique_key": "FALSE",
    "status": 1,
    "created_at": "2022-01-20T09:30:09Z",
    "updated_at": "2022-01-20T09:30:09Z"
  }
  // ...
]

ADD
Internal

앱에 사용자 프로퍼티 키를 추가합니다.

payload 하위 파라미터로 사용자 프로퍼티 키 정보를 전달합니다.

요청 처리 성공 시 응답은 payload에 추가 후 사용자 프로퍼티 키 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
name	`String`	사용자 프로퍼티 키 이름	O
data_type	`DataType`	사용자 프로퍼티의 데이터 타입	O
unique_key	`Boolean`	사용자 프로퍼티 키의 유일성(Unique key) 보장 여부 `TRUE`: 보장 `FALSE`: 보장하지 않음 (기본값: `FALSE`)	X

응답 페이로드

UserPropertyKey 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/propertyKey" \
  -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": {
            "name": "test_property_key",
            "data_type": "BOOLEAN"
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 5455625,
    "app_id": 1159110,
    "name": "test_property_key",
    "data_type": "BOOLEAN",
    "unique_key": "FALSE",
    "status": 1,
    "created_at": "2023-07-14T08:59:20Z",
    "updated_at": "2023-07-14T08:59:20Z"
  }
  // ...
]

REMOVE
Internal

앱의 사용자 프로퍼티 키를 삭제합니다.

payload 하위 파라미터로 삭제할 사용자 프로퍼티 키의 name을 전달합니다.

요청 처리 성공 시 응답은 payload에 삭제 후 사용자 프로퍼티 키 목록을 포함합니다.

요청 페이로드

이름	타입	설명	필수
name	`String`	사용자 프로퍼티 키 이름	O

응답 페이로드

UserPropertyKey 배열

요청 예제

curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/user/propertyKey" \
  -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": "REMOVE",
        "payload": {
            "name": "test_property_key"
        }
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 5147194,
    "app_id": 1159110,
    "name": "msg_blocked",
    "data_type": "STRING",
    "unique_key": "FALSE",
    "status": 1,
    "created_at": "2022-01-20T09:30:09Z",
    "updated_at": "2022-01-20T09:30:09Z"
  }
  // ...
]

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

내 애플리케이션: 사용자

제목 태그

사용자 조회

요청

액션

FIND_ALLInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제: 전달된 회원번호에 해당하는 사용자 없음

FIND_ALL_BY_ACCOUNT_IDInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제: 전달된 카카오계정 ID에 해당하는 사용자 없음

FIND_ALL_REGISTERED_AS_DEVELOPERInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

FIND_BY_ACCOUNT_IDInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

응답 예제: 조회 실패

사용자 ID 변환

요청

액션

CONVERT_FROM_APP_USER_ID

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CONVERT_FROM_ACCOUNT_ID

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CONVERT_FROM_TALK_USER_ID

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CONVERT_FROM_ACCESS_TOKEN

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CONVERT_FROM_REFRESH_TOKEN

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CONVERT_FROM_FRIEND_UUID

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CONVERT_FROM_EMAILInternal

요청 페이로드

응답 페이로드

요청 예제

응답 예제

사용자 및 사용자 프로퍼티

요청

FIND_ALL
Internal

FIND_ALL_BY_ACCOUNT_ID
Internal

FIND_ALL_REGISTERED_AS_DEVELOPER
Internal

FIND_BY_ACCOUNT_ID
Internal

CONVERT_FROM_EMAIL
Internal

FIND_ALL_USER_AND_PROPERTY
Internal

FIND_ALL_USER_AND_PROPERTY_REGISTERED_AS_DEVELOPER
Internal

FIND
Internal

UPDATE
Internal

FIND_ALL
Internal

ADD
Internal

REMOVE
Internal