사이드 메뉴
커뮤니케이션
API 제공
어드민 API
어드민 사용자 관리
신규 어드민 API 제공
이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.
이 문서는 사용자 관리를 위한 어드민 API 사용 방법을 설명합니다.
/security API는 사용자 신원, 권한 조회 기능을 제공합니다.
| 메서드 | 호스트 | 리소스 |
|---|---|---|
POST | internal-admin-kapi.kakao.com | /security |
| 이름 | 설명 |
|---|---|
| WHOAMI | 현재 사용자의 정보를 확인합니다. |
| CHECK_PERMISSION | 현재 사용자가 지정한 리소스 및 액션에 대한 접근 권한을 갖고 있는지 확인합니다. |
| ISSUE_TOKEN | 현재 사용자에게 TOKEN 타입 2차 인증에 사용 가능한 토큰을 발급합니다. |
현재 사용자의 정보를 확인합니다. 이 액션은 사용자 ID, 타입, 그룹 정보를 확인하는 데 사용합니다. 요청 시 전달해야 할 payload는 없습니다.
요청 페이로드
- 없음
응답 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| group | String | 사용자가 속한 그룹 이름 | O |
| user | String | 사용자 ID | O |
| user_type | String | 사용자 ID 타입kakao: 카카오계정 IDdeveloper: 개발자 계정 IDuser: ByBass, Static 인증 타입으로 요청한 경우ldap: 사내 계정 IDapp: 앱 ID나 앱 키로 요청한 경우 | O |
| user_role | String | 사용자 권한 이름 | X |
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/security" \-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": "WHOAMI"}'
응답 예제
// HTTP/2 200{"group": "${GROUP_NAME}","user": "test.user","user_type": "ldap"}
현재 사용자가 지정한 API 및 액션에 대한 접근 권한을 갖고 있는지 확인합니다.
요청 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| resource | String | 조회 대상 API의 URL (예: /app/:app_id/appKey) | O |
| action | JSON | 조회 대상 액션 정보 | O |
payload.action
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| name | String | 액션 이름 | O |
응답 페이로드
true(권한 있음) 또는false(권한 없음) 중 하나
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/security" \-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": "CHECK_PERMISSION","payload": {"resource": "/app/:app_id/appKey","action": {"name": "FIND"}}}'
응답 예제
// HTTP/2 200true
현재 사용자에게 TOKEN 타입 2차 인증에 사용 가능한 토큰을 발급합니다.
요청 처리 성공 시 응답은 토큰 값 문자열을 payload에 포함합니다.
요청 페이로드
- 없음
응답 페이로드
- 토큰 값 문자열
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/security" \-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": "ISSUE_TOKEN"}'
응답 예제
// HTTP/2 200"${TOKEN}"