KeyTypeEnum
stringAllowed values:legacynew
ApiKey
objectAn ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
Allowed values:legacynew
ListRealmConsumers
objectThe 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"}
Show Child Parameters
Pagination metadata.
Show Child Parameters
ConsumerWithRealm
objectThe 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.
The Consumer ID.
Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8
The unique username of the Consumer. You must send either this field or custom_id with the request.
Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.
Type of the consumer.
Allowed values:proxydeveloperadminapplication
Default:proxy
A list of consumer groups that the Consumer is in.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
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
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ListRealms
objectShow Child Parameters
Pagination metadata.