Delete a Forward Identity.
DELETE /api/v1/forward/identities/{identity_id}
After deletion, the Identity cannot be used to create sessions or perform other operations that require a valid Identity.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | Yes | Forward Identity ID. |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Deleted Identity ID. |
deleted | boolean | Whether deletion is complete. A successful response returns true. |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | The PAT or SAT is invalid or expired. |
| 404 | not_found_error | - | The Identity does not exist or is not visible to the caller. |
| 409 | conflict_error | - | The Identity cannot be deleted in its current state. |
Notes
- A deleted Identity cannot be used to create new sessions.
- Historical sessions, events, and audit records are not affected by this operation.