Delete a key

Delete a key. This operation removes the key from the system, causing all future authentication
requests using this key to fail. However, it does not immediately invalidate any
cached keys stored in the gateway’s state. These keys may remain usable until the cache expires, based on the
TTL (Time-To-Live) configured for the realm.

delete

Path Parameters

realmIdstring(uuid)required

ID of the realm

consumerIdstringrequired

ID of the of the consumer

keyIdstringrequired

ID of the key

Response

success

delete/realms/{realmId}/consumers/{consumerId}/keys/{keyId}
 

RealmConsumerFilterParameters

object
custom_id

Filter using one of the following operators: eq

Show Child Parameters
username

Filter using one of the following operators: eq

Show Child Parameters
Example

ConsumerFilterParameters

object
custom_id

Filter using one of the following operators: eq

Show Child Parameters
username

Filter using one of the following operators: eq

Show Child Parameters
Example

CreateApiKeyPayload

One Of
typestringrequired

Allowed values:new

Default:new

tagsarray[string]unique-items
Example

CreateApiKeyPayloadNew

object
* Additional properties are NOT allowed.
typestringrequired

Allowed values:new

Default:new

tagsarray[string]unique-items
Example