사용자 삭제

사용자를 삭제하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “USER” 유형 API를 만듭니다.

API 만들기

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 요청 형식

POST 형식으로 요청해야 합니다.

JSON 요청 형식입니다.

이름

유형

설명

필수 입력

action

문자열

작업 유형

USER_REMOVE

userId

문자열

삭제할 사용자 아이디. API 호출자는 삭제할 수 없습니다.

user01

예제는 다음과 같습니다.

{
	"action": "USER_REMOVE",
    "userId": "user01"
}

API 응답

USER_REMOVE 응답

JSON 형식의 응답은 다음과 같습니다.

USER_REMOVE 응답

이름

유형

설명

필수 여부

status

문자열

상태

success | fail

errors

Error 객체 배열

예외

아니오


사용자를 삭제하면 삭제된 사용자의 문서에 대한 “소유자” 권한이 API 호출자에게 자동으로 옮겨집니다.

예외 항목

예외 항목은 다음과 같습니다.

예외

설명

CALLER_REMOVE_NOT_ALLOWED

API 호출자를 삭제하려고 할 때

USER_NOT_EXIST

삭제할 그룹이 존재하지 않을 때

EMPTY_JSON_PARAMTER

API 요청에 groupid가 없을 때

예제

예제입니다.

{
	"status": "success"
}