사용자를 만드는 API입니다.

API 만들기

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

API 요청 형식

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

JSON 요청 형식입니다.

이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	USER_CREATE
userId	문자열	사용자 아이디	예	user01
name	문자열	이름	예	사용자 01
email	문자열	이메일	예	dimdol@3rabbitz.com
locale	문자열	언어	아니오	ko \| en
timeZone	문자열	시간대	아니오	Asia/Seoul
password	문자열	비밀번호. OAuth 2.0을 적용했다면 입력할 필요가 없습니다.	아니오
roles	문자열 배열	권한 목록	아니오	["ADMIN", "EDITOR", "WRITER"]
groups	문자열 배열	그룹 아이디 목록	아니오	["group01", "group02"]

예제는 다음과 같습니다.

{
    "userid": "user1",
    "name": "사용자 1",
    "email": "support@3rabbitz.com",
    "locale" : "ko",
    "timeZone": "Asia/Seoul",
    "password": "1234",
    "roles": ["ADMIN", "EDITOR", "WRITER"],
    "groups": ["group1", "group2"]
}

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

권한	설명
ADMIN	관리
EDITOR	서식 만들기
WRITER	글 쓰기
READER	글 읽기

API 응답

`USER_CREATE` 응답

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

`USER_CREATE` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오

예외 항목

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

예외	설명
GROUP_NOT_EXIST	그룹이 존재하지 않을 때
INVALID_PARAMETER	문자열의 길이 등이 형식에 맞지 않을 때
INVALID_PARAMETER	비밀번호 형식이 맞지 않을 때
INVALID_USER_ID	사용자 아이디 형식이 맞지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
USER_ID_CONFLICT	사용자 아이디가 이미 존재할 때
UNSUPPORTED_LOCALE	해당 언어를 지원하지 않을 때
USER_LICENSE_EXCEEDED	사용자 라이선스 초과

예제

예제입니다.

{
	"status": "success"
}

API 만들기

API 요청 형식

API 응답

USER_CREATE 응답

예외 항목

예제

`USER_CREATE` 응답