IAM - Test Document Permissions

POST

/org/:org_id/project/:project_id/document/:document_id/iam/test

Test the permissions that the caller (or another subject) holds on the document.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

document_idstringRequiredformat: "uuid"

org_idstringRequiredformat: "uuid"

The org id

project_idstringRequiredformat: "uuid"

The project id

Request

This endpoint expects an object.

permissionslist of enumsRequired

A list of permissions to test on the document.

memberstring or nullOptional

Response

Document permissions tested successfully

permissionslist of strings

memberstring or nullOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/document/document_id/iam/test \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"permissions": [
>	"view",
>	"edit",
>	"view_members"
>	]
>	}'

1	{
2	"permissions": [
3	"edit",
4	"view",
5	"view_members"
6	],
7	"member": "user:0190c234-1111-2222-3333-444444444444"
8	}