Documents

Remove a user from a document

DELETE/documents/{id}/user-permissions/{member_id}
documents:writeremove_document_user_permissionsDestructiveIdempotent

Removes the user from every level of the document and returns 204. A folder above that still grants access applies again through inheritance. It returns 204 when the user has no access, so a retry is safe. Needs write access to the document, else 403 forbidden. No dry run. Emits document.updated after commit; no email. POST /documents/{id}/user-permissions undoes it.

Path parameters

  • idstring (uuid)Required#

    The record's id.

  • member_idstring (uuid)Required#

    The user to remove.

Responses

204

The user no longer has access through this document.

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 DELETE https://your-org-domain/kong/core/api/v2/documents/{id}/user-permissions/{member_id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"