Internal Users

Take a role from an internal user

DELETE/internal-users/{id}/roles/{member_id}
internal-users:writeremove_internal_user_rolesDestructiveIdempotent

Removes the role from the internal user and returns 204; a role the user does not hold also returns 204 and changes nothing. It has no dry run and needs no super-admin caller. A SCIM-managed user returns 409 scim_managed. Emits internal_user.updated with roles as the changed field when it changed, and the legacy user.* events; sends no email. POST /internal-users/{id}/roles undoes it.

Path parameters

  • idstring (uuid)Required#

    The internal user's id, a uuid. An unknown user, or one outside the token's organisation, returns 404.

  • member_idintegerRequired#

    The role to take away.

Responses

204

The internal user no longer holds the role.

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
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

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/internal-users/{id}/roles/{member_id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"