Documents

List the users with access to a document

GET/documents/{id}/user-permissions
documents:readread_document_user_permissionsRead-only

Returns every user with read or write on the document, the same list the add, remove and replace calls return, inherited members from the folder included. A document the token can't see, a deleted document and an unknown id all return 404. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Responses

200

Every user with access to the document.

DocumentUserPermission[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "level": "read"
    }
  ]
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/documents/{id}/user-permissions\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"