Documents

Read document permissions

GET/documents/{documentId}/permissions
documents:readget_document_permissionsRead-onlyDeprecatedSunset 2027-06-30

Returns a document's access control: the structured permissions object plus the flat read_access and write_access uuid arrays. A document the token cannot read returns 404. Deprecated: use GET /documents/{id}/user-permissions and GET /documents/{id}/team-permissions instead. Withdrawn on 2027-06-30. Responses carry Deprecation, Sunset and a successor Link.

Path parameters

  • documentIdstring (uuid)Required#

    The document's public uuid.

Responses

200

OK

DocumentPermissions
{
  "data": {
    "id": "5e6f7081-92a3-4b4c-9d6e-7f8091a2b3c4",
    "permissions": {
      "user": {
        "none": [],
        "read": [
          "3f1c9d22-1a2b-4c3d-8e4f-5a6b7c8d9e0f"
        ],
        "write": []
      },
      "group": {
        "none": [],
        "read": [],
        "write": []
      }
    },
    "read_access": [
      "3f1c9d22-1a2b-4c3d-8e4f-5a6b7c8d9e0f"
    ],
    "write_access": []
  }
}
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/{documentId}/permissions\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"