접근 권한 목록을 반환하는 API입니다. 그룹이나 프로젝트 등의 선언 데이터가 아닌 실제 사용자 목록을 반환합니다.

API 만들기

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

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

API 요청

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

요청 URL 형식입니다.

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

URL 파라미터 항목입니다.

URL 파라미터
이름	유형	설명	필수 여부	예
uuid	UUID	API UUID	예	8458cdd8b015ca04
action	문자열	작업 유형	예	ACCESS_CONTROL_LIST
subject	문자열	접근 권한 목록을 확인할 문서나 프로젝트의 UUID 같은 이름으로 여러 데이터를 넘길 수 있습니다.	예	a162f15952712c06
type	문자열	접근 권한 유형	예

다음과 같은 type이 있습니다.

BOOK_OWNER: 문서 소유자
BOOK_COLLABORATOR: 문서 협업자
BOOK_REVIEWER: 문서 독자
PROJECT_LEADER: 프로젝트 리더
PROJECT_MEMBER: 프로젝트 구성원
OWNER: 파일, 그림 등의 자원 디렉터리 리더
COLLABORATOR: 파일, 그림 등의 자원 디렉터리 구성원

요청 URL 예제입니다.

/r/api/8458cdd8b015ca04?action=ACCESS_CONTROL_LIST&subject=84d49753d2d65aeb&subject=1bcabeefa628708d&type=BOOK_OWNER

API 응답

`ACCESS_CONTROL_LIST` 응답

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

`ACCESS_CONTROL_LIST` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
subjects	`JsonObject` 객체	subject를 키로, User 객체 배열을 값으로 하는 객체	예

`User` 객체

`User` 객체
이름	유형	설명	필수 여부	예
id	문자열	UUID	예	5b969d63e97cfec7
userId	문자열	사용자 아이디	예	user01
name	문자열	사용자 이름	예	사용자 01
email	문자열	이메일	예	support@3rabbitz.com

예외 항목

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

ACCESS_CONTROL_LIST 예외 항목
예외	설명
INVALID_PARAMETER	`type`이 접근 권한 유형이 아닐 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목(`subject`, `type`)이 없을 때

subject에 해당하는 문서나 프로젝트가 없어도 오류를 반환하지 않고, 그 subject의 값으로 빈 배열을 반환합니다.

예제

예제입니다.

{
    "status": "success",
    "subjects": {
		"84d49753d2d65aeb": [
			{
            	"id": "5b969d63e97cfec7",
				"userId": "user01",
				"name": "사용자 1",
				"email": "user01@3rabbitz.com"
            },
    		{
            	"id": "43bc63721537bf19",
				"userId": "user02",
				"name": "사용자 2",
				"email": "user02@3rabbitz.com"
        	}
		],
		"1bcabeefa628708d": []
	}
}