ListRealms

object
dataarray[object]required
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
Example

ListConsumers

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"}

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
Example

ListKeys

object
dataarray[object]required
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
Example

ConsumerRealm

object
idstringrequired
namestringrequired
ttlintegerrequired

The time in minutes that the Consumer will be cached in memory on a running Gateway if it is
successfully loaded from Konnect.

Default:10

>= 5

negative_ttlintegerrequired

If a running Gateway triggers a lookup for a Consumer that cannot be authenticated this realm, a negative_ttl
is set. The Gateway will not try to lookup the Consumer in Konnect for negative_ttl minutes.

A Consumer will be cached for negative_ttl if they do not exist in the Realm, or if the provided credentials
are invalid.

Default:10

>= 5

consumer_groupsarray[string](set)requiredunique-items

A list of consumer groups to automatically add to any consumers created within this Realm.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.

allowed_control_planesarray[string](set)requiredunique-items

List of control plane ids that are allowed to use the realm. This is used when allow_all_control_planes value
is set to false.

allow_all_control_planesbooleanrequired

Allow all control planes to use the realm. When this value is set it takes precedence on allowed_control_planes.

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

Example

RealmReference

object
realm_idstringrequired
Example