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
Authentication
Path Parameters
Query Parameters
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.
List realm consumers
List all realm-scoped consumers. This operation allows you to look for consumers across multiple realms.
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
Filters Consumers in the response.
Show Child Parameters
Response
200 application/json
Response
success
ListRealmConsumers
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","realm_id":"77fd4d02-5d87-4f76-90a9-1bd6ce152c36"}
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Query Parameters
List consumers
List all consumers that are a member of this realm.
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
Filters Consumers in the response.
Show Child Parameters
Path Parameters
ID of the realm
Response
application/json
Response
success
ListConsumers
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"}
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a consumer
Create a new consumer in this Realm. It will be available to use for authentication within a few seconds, unless
the consumer’s username is blocked in the Gateway. If this is the case, the new consumer will be available in
negative_ttl (see the Realm definition) seconds.
Path Parameters
ID of the realm
Body
application/json
Body
ConsumerCreateRequest
The unique username of the Consumer.
>= 1 characters
Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.
>= 1 characters
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.
Type of the consumer.
Allowed values:proxydeveloperadminapplication
Default:proxy
Response
application/json
Response
success
CentralizedConsumer
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.
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