RealmReference

object
realm_idstringrequired
Example

MoveConsumerRequest

object
target_realm_idstringrequired
Example

ConsumerRealmCreateRequest

object
* Additional properties are NOT allowed.
namestringrequired
allowed_control_planesarray[string](set)unique-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_planesboolean

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

ttlinteger

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_ttlinteger

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)unique-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.

Example

UpdateConsumerPayload

object
* Additional properties are NOT allowed.
usernamestring

The unique username of the Consumer.

>= 1 characters

custom_idstring

Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.

>= 1 characters

consumer_groupsarray[string]unique-items

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.

typestring

Type of the consumer.

Allowed values:proxydeveloperadminapplication

Default:proxy

tagsarray[string]unique-items
Example

AllowAllControlPlanes

boolean

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