Delete client
keycloak_client_deletePermanently delete a Keycloak client by its clientId. Requires confirm=true to execute; without confirmation the operation aborts to prevent accidental removal.
Instructions
Permanently delete a client from the realm. This is a destructive operation and is not idempotent: once deleted, deleting the same clientId again fails because it no longer exists. Requires explicit confirmation via confirm=true (otherwise it aborts without deleting). Use keycloak_client_get to verify the target first, and keycloak_client_update to merely disable a client instead of removing it. Returns a confirmation message, or a reason string when not deleted.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Must be true to actually delete the client. When false or omitted (default), the operation is aborted and nothing is removed; this guards against accidental deletion. | |
| clientId | Yes | The clientId of the client to delete (the human-readable OAuth/OIDC identifier), not the internal UUID. Required. |