DKBSignDocs

API reference

POSTRequires Bearer token

Grant a permission

/api/edm/permissions

Exactly one of folder_id or document_id. Rights: can_read (default true), can_download, can_deposit, can_delete, can_manage (default false). A company admin has full access in their organisation.

Path parameters

This endpoint has no path parameters.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
subject_type
Required
stringrole or user.
e.g. "role"
subject_id
Required
stringRole name or user id.
e.g. "manager"
folder_id
stringTarget folder (xor document_id).
document_id
stringTarget document (xor folder_id).
can_read
booleanDefault true.
e.g. true
can_download
booleanDefault false.
e.g. true
can_deposit
booleanDefault false.
e.g. false
can_delete
booleanDefault false.
e.g. false
can_manage
booleanDefault false.
e.g. false

Responses

StatusMeaning
201Permission created
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/edm/permissions' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"subject_type":"role","subject_id":"manager","can_read":true,"can_download":true,"can_deposit":false,"can_delete":false,"can_manage":false}'

Response 201

json
{
  "id": "perm-1",
  "subject_type": "role",
  "can_read": true
}