Create a consumer group
Create a consumer group.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Body
application/json
Body
Consumer request body
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.
An optional set of strings associated with the Consumer for grouping and filtering.
Response
200 application/json
Response
The consumer object response body
Show Child Parameters
Pagination information
Example:http://localhost:8001/consumers?offset=6378122c-a0a1-438d-a5c6-efabae9fb969
Authentication
Path Parameters
Body
Delete consumer group
Delete consumer group.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Response
204
Response
No Content
Authentication
Path Parameters
List all consumers in a consumer group
Returns a list of consumers that belong to a consumer group.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Response
200
Response
Example response
Show Child Parameters
Authentication
Path Parameters
Add a consumer to a group
Add a consumer to a group
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Body
application/json
Body
The consumer ID for the consumer that you want to add to a group.
Example:288f2bfc-04e2-4ec3-b6f3-40408dff5417
Response
201 application/json
Response
The response body returns a consumer group and the associated consumers.
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Body
Remove all consumers from a consumer group
Removes all consumers from a consumer group. Does not delete any consumers.consumers.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The UUID of the consumer group.
Example:be4bcfca-b1df-4fac-83cc-5cf6774bf48e
Response
204
Response
No Content