Documents

Grant a user access to a document

POST/documents/{id}/user-permissions
documents:writeadd_document_user_permissionsIdempotent

Gives a user read or write on the document and returns every member. read sees the document, write also changes it. It grants exactly that level and removes the user from the other one. Needs write access to the document, else 403 forbidden. Emits document.updated after commit; no email. DELETE /documents/{id}/user-permissions/{member_id} undoes it.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DocumentUserPermission

  • idstring (uuid)Required#

    The user's id.

  • levelstringRequired#

    What the user may do: read sees the document, write also changes it.

    One of: read, write
{
  "id": "9d8c7b6a-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "level": "read"
}

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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/documents/{id}/user-permissions\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "id": "9d8c7b6a-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "level": "read"
}'