Soft-delete an identity.
HTTP 200 OK
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | Yes | ID of the identity to delete. |
Example request
Example response
HTTP 200 OK
Response body
| Field | Type | Description |
|---|---|---|
id | string | ID of the deleted identity. |
deleted | boolean | Whether the identity is marked as deleted. |
Response codes
| HTTP | Type | Trigger |
|---|---|---|
| 404 | not_found_error | The identity doesn't exist or isn't visible to the caller. |
| 409 | conflict_error | The identity can't be deleted in its current state. |
| 401 | authentication_error | The PAT is invalid or expired. |
Notes
- A deleted identity can't be used to create new sessions.
- Deletion is soft; historical records are preserved.