Internal Users

Deactivate an internal user

DELETE/internal-users/{id}
internal-users:writedelete_internal_userDestructiveIdempotent

Deactivates the internal user: a soft delete that ends their sessions and leaves them out of every list and read. It returns 204; a repeat returns 404. The API cannot reverse it. A SCIM-managed user returns 409 scim_managed. A token cannot delete its own acting user: that returns 409 invalid_state. Only a super admin can delete a user who is a super admin; anyone else, including an organisation token with no personal user, gets 403 forbidden. It has no dry run. Emits internal_user.deleted and the legacy user.deactivated; sends no email.

Path parameters

  • idstring (uuid)Required#

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

Responses

204

The internal user was deactivated.

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}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"