Update a consumer
Update a Consumer’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
ID of the of the consumer
Body
application/json
Body
UpdateConsumerPayload
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
Authentication
Path Parameters
Body
Delete a consumer
Delete a consumer. This operation removes the consumer from the system, causing all future authentication
requests using keys associated with that consumer to fail. However, it does not immediately invalidate any
cached keys stored in the gateway’s state. These keys may remain usable until the cache expires, based on the
TTL (Time-To-Live) configured for the realm.
Path Parameters
ID of the realm
ID of the of the consumer
Response
Response
success
Authentication
Path Parameters
Change the realm of a consumer
Change the realm membership of a consumer without changing their credentials.
Path Parameters
ID of the realm
ID of the of the consumer
Body
application/json
Body
MoveConsumerRequest
Response
application/json
Response
success
RealmReference
Authentication
Path Parameters
Body
Centrally Managed Keys
Centrally managed consumers use key-auth mechanism to authenticate consumers. Keys refer to the API key credential used by the consumer to authenticate to your services.
List keys
List all the credential keys related to this consumer.
These keys are used by the kay-auth plugin to authenticate the consumer.
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
Path Parameters
ID of the realm
ID of the of the consumer
Response
application/json
Response
success
ListKeys
Show Child Parameters
Pagination metadata.