사용자를 반환하는 API입니다.

API 만들기

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

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

API 요청

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

요청 URL 형식입니다.

/r/api/${uuid}?action=USER_GET&userId=${userId}

URL 파라미터 항목입니다.

이름	유형	설명	필수 여부	예
uuid	문자열	API UUID	예	5b969d63e97cfec7
action	문자열	작업 유형	예	USER_GET
userId	문자열	사용자 아이디	예	user01

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=USER_GET&userId=user01

API 응답

`USER_GET` 응답

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

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

`User` 객체

User 객체는 다음과 같습니다.

`User` 객체
이름	유형	설명	필수 여부	예
id	문자열	UUID	예	5b969d63e97cfec7
userId	문자열	사용자 아이디	예	user01
name	문자열	사용자 이름	예	사용자 01
email	문자열	이메일	예	user01@3rabbitz.com
locale	문자열	언어	아니오	`ko` 또는 `en`
timeZone	문자열	시간대	아니오	Asia/Seoul
roles	문자열 배열	권한 목록	예. 권한이 없을 때는 빈 배열을 반환합니다.	["ADMIN", "EDITOR", "WRITER"]
groups	Group 객체 배열	그룹 목록	예. 그룹이 없을 때는 빈 배열을 반환합니다.

사용자가 속한 그룹 목록(groups)은 매뉴얼웍스 6.0.4 버전부터 지원합니다.

`Group` 객체

Group 객체는 다음과 같습니다.

`Group` 객체
이름	유형	설명	필수 여부	예
groupId	문자열	그룹 아이디	예	group01
name	문자열	그룹 이름	예	그룹 01

예외 항목

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

예외	설명
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
USER_NOT_EXIST	사용자가 존재하지 않을 때

예제

예제입니다.

{
	"status": "success",
	"user": {
	    "userId": "user1",
    	"name": "사용자 1",
	    "email": "user01@3rabbitz.com",
    	"locale" : "ko",
	    "timeZone": "Asia/Seoul",
	    "roles": ["ADMIN", "EDITOR", "WRITER"],
        "groups": [
			{
				"groupId": "group01",
				"name": "그룹 01"
			},
			{
				"groupId": "group02",
				"name": "그룹 02"
			}
		]
	}
}