Permanently delete an identity. This operation cannot be undone. Use this for data cleanup, compliance requirements, or when removing entities from your system. Important:Documentation Index
Fetch the complete documentation index at: https://unkey.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
- Associated API keys remain functional but lose shared resources
- External ID becomes available for reuse immediately
identity.*.delete_identity(to delete identities in any workspace)
See the API reference for the full HTTP endpoint documentation.
Usage
Flags
The ID of the identity to delete. This can be either the external ID (from your own system that was used during identity creation) or the identity ID (the internal ID returned by the identity service).
Global Flags
| Flag | Type | Description |
|---|---|---|
--root-key | string | Override root key ($UNKEY_ROOT_KEY) |
--api-url | string | Override API base URL (default: https://api.unkey.com) |
--config | string | Path to config file (default: ~/.unkey/config.toml) |
--output | string | Output format. Use json for raw JSON |
Examples
Output
Default output shows the request ID with latency:--output=json, the full response envelope is returned: