Create a realm

Create a new Realm. Centrally Managed Consumers are created within a Realm.

Each Realm can be restricted to a specific set of control planes if needed using allowed_control_planes or allow_all_control_planes.

ttl and negative_ttl control how long the consumers are kept in memory by a running Gateway.

Any consumer_groups added to the Realm are automatically applied to all consumers within this Realm.

post

Body

application/json

ConsumerRealmCreateRequest

* 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.

Response

application/json

success

ConsumerRealm

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

post/realms

Body

{ "name": "kingdom" }
 
application/json

Get a realm

Fetch the details of a specific realm, identified by its UUID

get

Path Parameters

realmIdstring(uuid)required

ID of the realm

Response

200 application/json

success

ConsumerRealm

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

get/realms/{realmId}
 
200 application/json

Update a realm

Update a realm’s details. Any consumers already cached in a running Gateway will not be affected body
the changes to the Realm until ttl minutes have passed.

patch

Path Parameters

realmIdstring(uuid)required

ID of the realm

Body

application/json

ConsumerRealmUpdateRequest

* Additional properties are NOT allowed.
namestring
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.

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.

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

Response

application/json

success

ConsumerRealm

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

patch/realms/{realmId}

Body

{ "name": "MyKingdom" }
 
application/json

Delete a realm

Delete a Realm, and all consumers and credentials containined within the Realm.

Only empty Realms can be deleted, unless you specify ?force=true as a query string parameter in your request.

delete

Query Parameters

forcestring

If true, delete specified realm and all underlying entities (consumers/apiKeys). If false, do not allow deletion if there are underlying entities.

Allowed values:truefalse

Default:false

Path Parameters

realmIdstring(uuid)required

ID of the realm

Response

success

delete/realms/{realmId}
 

Centrally Managed Consumers

Consumers can be scoped to a Konnect region and managed centrally, or be scoped to a control plane in Gateway Manager. Use centrally managed consumers to set up identity of the consumer once, and share it across multiple control planes. Consumers that are managed centrally aren’t part of the configuration that is pushed down from the control plane to the data planes, so it reduces config size and latency.