Skip to content

Delete an OAuth/OIDC client.

DELETE
/api/admin/clients/{id}
Code sample: Shell / cURL
curl --request DELETE \
--url https://auth.example.com/api/admin/clients/example \
--header 'Authorization: Bearer <token>'

Delete Client in the Clients area. The operation changes tenant state and should be protected by the documented admin authorization and audit controls.

id
required
string
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Successful delete response.

Media type application/json
object
success
required
boolean
message
required
string
key
additional properties
Example
{
"success": true,
"message": "User deleted successfully"
}
X-Authrim-Log-Consistency
string
Allowed values: snapshot eventual local_hot_only

Snapshot for the remote scheduled view; eventual when Pipeline visibility can lag ingestion; local_hot_only for local scheduled staging without a remote Catalog.

X-Authrim-Log-Pending-Deliveries
integer

Tenant deliveries not yet confirmed visible. Omitted for self-service subjects. Zero does not guarantee immediate Pipeline visibility.

X-Authrim-Log-Complete
boolean

True only for a complete bounded snapshot query. Pipeline responses remain false; incomplete reads return 503.