List realms
List all available realms. The full configuration of each Realm is returned under the data key
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Response
200 application/json
Response
success
ListRealms
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Query Parameters
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.
Body
application/json
Body
ConsumerRealmCreateRequest
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 planes to use the realm. When this value is set it takes precedence on allowed_control_planes.
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
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
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
Response
success
ConsumerRealm
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
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
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.
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 planes to use the realm. When this value is set it takes precedence on allowed_control_planes.
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
Authentication
Body
Get a realm
Fetch the details of a specific realm, identified by its UUID
Path Parameters
ID of the realm
Response
200 application/json
Response
success
ConsumerRealm
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
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
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.
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 planes to use the realm. When this value is set it takes precedence on allowed_control_planes.
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
Authentication
Path Parameters
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.
Path Parameters
ID of the realm
Body
application/json
Body
ConsumerRealmUpdateRequest
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 planes to use the realm. When this value is set it takes precedence on allowed_control_planes.
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.
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
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
Response
success
ConsumerRealm
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
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
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.
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 planes to use the realm. When this value is set it takes precedence on allowed_control_planes.
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
Authentication
Path Parameters
Body
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.
Query Parameters
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
ID of the realm
Response
Response
success