identities

Delete Identity

Permanently delete an identity. This operation cannot be undone.

Use this for data cleanup, compliance requirements, or when removing entities from your system.

Important Requires identity.*.delete_identity permission Associated API keys remain functional but lose shared resources External ID becomes available for reuse immediately

post/v2/identities.deleteIdentity

Request body

identitystring required

The ID of the identity to delete. This can be either the externalId (from your own system that was used during identity creation) or the identityId (the internal ID returned by the identity service).

Example request

{
  "identity": "user_123"
}

Response

Identity successfully deleted

Example response

{
  "meta": {
    "requestId": "req_123"
  }
}

Changes

Changed in 3 of the 90 revisions of this API.4

    • the endpoint scheme security bearer was added to the API

      api-security-added

    • the endpoint scheme security rootKey was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the non-success response with the status 429

      response-non-success-status-added

    • api operation id v2.identities.deleteIdentity removed and replaced with identities.deleteIdentity

      api-operation-id-removed