사용자 목록 가져오기

사용자 목록을 반환하는 API입니다.

API 만들기

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

API 만들기

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

API 요청

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

요청 URL 형식입니다.

/r/api/${uuid}?action=USER_LIST

URL 파라미터 항목입니다.

이름

유형

설명

필수 여부

uuid

UUID

API UUID

5b969d63e97cfec7

action

문자열

작업 유형

USER_LIST

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=USER_LIST

API 응답

USER_LIST 응답

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

USER_LIST 응답

이름

유형

설명

필수 여부

status

문자열

상태

success | fail

errors

Error 객체 배열

예외

아니오


users

User 객체 배열

사용자 데이터 목록. 사용자 이름으로 정렬합니다.


사용자가 없을 때는 users로 빈 배열을 반환합니다.

User 객체

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

User 객체

이름

유형

설명

필수 여부

id

문자열

UUID

5b969d63e97cfec7

userId

문자열

사용자 아이디

user01

name

문자열

사용자 이름

사용자 01

email

문자열

이메일

user01@3rabbitz.com

locale

문자열

언어

아니오

ko 또는 en

timeZone

문자열

시간대

아니오

Asia/Seoul

roles

문자열 배열

권한 목록

예. 권한이 없을 때는 빈 배열을 반환합니다.

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

예제

응답 예제입니다.

{
    "status": "success",
    "users": [
		{
			"id": "",
	    	"userId": "user01",
	    	"name": "사용자 1",
		    "email": "user01@3rabbitz.com",
    		"locale" : "ko",
	    	"timeZone": "Asia/Seoul",
	    	"roles": ["ADMIN", "EDITOR", "WRITER"]
    	},
		{
			"id": "",
	    	"userId": "user02",
	    	"name": "사용자 2",
		    "email": "user02@3rabbitz.com",
    		"locale" : "ko",
	    	"timeZone": "Asia/Seoul",
		    "roles": ["WRITER"]
		}
	]
}