List keys
List all the credential keys related to this consumer.
These keys are used by the kay-auth plugin to authenticate the consumer.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
ID of the realm
ID of the of the consumer
Response
application/json
Response
success
ListKeys
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a key
This operation generates an API key for the specified consumer. The key is returned only at the time of creation
and will not be retrievable in any subsequent GET requests on the entity.
The API supports two key creation types: new and legacy.
new: The recommended and more efficient option. The API automatically generates the key and returns it during
this operation.legacy: Allows you to provide your own secret. This approach has a performance impact when proxying requests, as it involves
additional processing and resource usage.
Note: Regardless of the type selected, the key is only returned by the API when a key is created. It is not retrievable in the future.
Path Parameters
ID of the realm
ID of the of the consumer
Body
application/json
Body
CreateApiKeyPayload
One OfAllowed values:new
Default:new
Response
application/json
Response
success
CreateApiKeyResult
Allowed values:legacynew
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get a key
Returns the key entity. This operation does NOT return the key itself. The key is only available at the time of creation.
Path Parameters
ID of the realm
ID of the of the consumer
ID of the key
Response
application/json
Response
success
ApiKey
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
Allowed values:legacynew
Authentication
Path Parameters
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.
Path Parameters
ID of the realm
ID of the of the consumer
ID of the key
Response
Response
success
Authentication
Path Parameters
RealmConsumerFilterParameters
objectFilter using one of the following operators: eq
Show Child Parameters
Filter using one of the following operators: eq