CreateApiKeyPayloadLegacy

object
* Additional properties are NOT allowed.
typestringrequired

Allowed values:legacy

Default:legacy

secretstringrequired

secret to be created. Must be unique within the realm. If not specified a secret will be automatically generated.

tagsarray[string]unique-items
Example

CreateApiKeyResult

object
idstringrequired
typestringrequired

Allowed values:legacynew

secretstringrequired
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

tagsarray[string]requiredunique-items
Example

KeyTypeEnum

string

Allowed values:legacynew

ApiKey

object
idstringrequired
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

tagsarray[string]requiredunique-items
typestringrequired

Allowed values:legacynew

Example

ListRealmConsumers

object
dataarray[object]required

The Consumer object represents a consumer - or a user - of a Service. You can either rely on Kong as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong and your existing primary datastore.

Example:{"custom_id":"4200","id":"8a388226-80e8-4027-a486-25e4f7db5d21","type":"proxy","consumer_groups":["gold"],"tags":["partner"],"username":"bob-the-builder","created_at":"2025-06-17T16:55:58.569399532Z","updated_at":"2025-06-17T16:55:58.569399532Z","realm_id":"77fd4d02-5d87-4f76-90a9-1bd6ce152c36"}

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
Example