문서에 대한 접근 권한을 설정하는 API입니다.

API 만들기

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

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

API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.

API 요청

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

JSON 요청 형식입니다.

이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	DOC_ACCESS_CONTROL
docId	UUID	문서 UUID	예	86ed5e400d38c511
+owners	Accessor 객체 배열	소유자로 추가할 항목의 배열	아니오
-owners	Accessor 객체 배열	소유자에서 제외할 항목의 배열	아니오
+collaborators	Accessor 객체 배열	협업자로 추가할 항목의 배열	아니오
-collaborators	Accessor 객체 배열	협업자에서 제외할 항목의 배열	아니오
+reviewers	Accessor 객체 배열	독자로 추가할 항목의 배열	아니오
-reviewers	Accessor 객체 배열	독자에서 제외할 항목의 배열	아니오

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

`Accessor` 객체
이름	유형	설명	필수 여부	예
type	문자열	유형	예	user \| group \| keyword
id	문자열	사용자 아이디 또는 그룹 아이디 또는 접근 권한 키워드	예

소유자를 추가하는 예제입니다.

{
    "action": "DOC_ACCESS_CONTROL",
    "docId": "686341e93e30d856",
    "+owners": [
		{
			"type": "user",
			"id": "user01"
		},
		{
			"type": "group",
			"id": "group01"
		}, 
		{
			"type": "keyword",
			"id": "PROJECT_MEMBERS"
		}
	]
}

소유자, 협업자, 독자 등을 함께 설정할 수 있습니다.

API 응답

`DOC_ACCESS_CONTROL` 응답

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

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

예외

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

예외	설명
DOC_NOT_EXIST	문서가 존재하지 않을 때
GROUP_NOT_EXIST	그룹이 존재하지 않을 때
INVALID_PARAMETER	키워드가 존재하지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
USER_NOT_EXIST	사용자가 존재하지 않을 때

예제

예제입니다.

{
	"status": "success"
}

API 만들기

API 요청

API 응답

DOC_ACCESS_CONTROL 응답

예외

예제

`DOC_ACCESS_CONTROL` 응답