Folders

Remove a user from a folder

DELETE/folders/{id}/user-permissions/{member_id}

Removes the user from every level of the folder, every subfolder and every document in them, 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 folder, else 403 forbidden (see that response). No dry run. Emits folder.updated after commit; no email. POST /folders/{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 folder.

401

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

Error
403

Authorization failed. error.code is forbidden when the token's user can't write the folder: any folder in the tree of a deal the token can see is writable, otherwise the folder's write list, write flags or super admin are needed. This is deliberately broader than the platform (no editor-role check) and stricter (the check applies where the platform skips it by role). Other codes are missing_scope, scope_disabled, org_disabled, ip_blocked, 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/folders/{id}/user-permissions/{member_id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"