사용자 권한 변경

사용자의 권한을 변경하는 API입니다.

API 만들기

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

API 만들기

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

API 요청

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

JSON 요청 형식입니다.

이름

유형

설명

필수 여부

action

문자열

작업 이름

USER_ROLE_UPDATE

userId

문자열

사용자 아이디

user01

roles

문자열 배열

권한 목록

["ADMIN", "EDITOR", "WRITER"]

기존 권한을 무시하고 roles에 설정한 권한으로 재설정합니다.

사용자의 권한을 변경하는 예제입니다.

{
    "action": "USER_ROLE_UPDATE",
    "userId": "user01",
    "roles": ["ADMIN", "EDITOR", "WRITER"]
}

지원하는 권한 문자열은 다음과 같습니다. 대문자를 사용해야 합니다.

권한

설명

ADMIN

관리

EDITOR

서식 만들기

WRITER

글 쓰기

READER

글 읽기

API 응답

USER_ROLE_UPDATE 응답

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

USER_ROLE_UPDATE 응답

이름

유형

설명

필수 여부

status

문자열

상태

success | fail

errors

Error 객체 배열

예외

아니오


예외 항목

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

예외

설명

USER_NOT_EXIST

사용자가 존재하지 않을 때

INVALID_PARAMETER

문자열의 길이 등이 형식에 맞지 않을 때

REQUIRED_PARAMETER_MISSING

API 요청에 필수 항목이 없을 때

예제

예제입니다.

{
	"status": "success"
}