그룹에서 사용자를 삭제하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “GROUP” 유형 API를 만듭니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | GROUP_REMOVE_USER |
groupId | 문자열 | 그룹 아이디 | 예 | group01 |
user | 문자열 | 삭제할 사용자 아이디 | 아니오 | user01 |
users | 문자열 배열 | 삭제할 사용자 아이디 목록 | 아니오 | ["user01", "user02"] |
사용자 한 명을 삭제하는 예제입니다.
{
"action": "GROUP_REMOVE_USER",
"groupId": "group01",
"user": "user01"
}사용자 여려 명을 삭제하는 예제입니다.
{
"action": "GROUP_REMOVE_USER",
"groupId": "group01",
"users": ["user01", "user02", "user03"]
}user와 users를 동시에 사용할 수 있습니다.
API 응답
GROUP_REMOVE_USER 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
GROUP_NOT_EXIST | 사용자를 삭제할 그룹이 존재하지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
USER_NOT_EXIST | 존재하지 않는 사용자가 있다면 모두를 삭제하지 않습니다. |
예제
예제입니다.
{
"status": "success"
}