List all Consumers
Retrieve a list of all consumers.You can use query parameters to filter the results by size or tags, for example /consumers?size=50&tags=enterprise.
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
New consumer created response
Unix epoch when the resource was created.
Example:1684424758
Field for the unique consumer ID
The unique id of the consumer.
Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27
An optional set of strings associated with the Consumer for grouping and filtering.
Unix epoch when the resource was updated.
Example:1684424758
The unique username of the consumer.
Authentication
Path Parameters
Query Parameters
Create a new Consumer
Create a new Consumer
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
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
application/json
Response
New consumer created response
Unix epoch when the resource was created.
Example:1684424758
Field for the unique consumer ID
The unique id of the consumer.
Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27
An optional set of strings associated with the Consumer for grouping and filtering.
Unix epoch when the resource was updated.
Example:1684424758
The unique username of the consumer.
Authentication
Path Parameters
Body
Delete a Consumer
Delete a specific consumer from the system using either the consumer ID or the consumer username. This operation is irreversible and permanently removes all data associated with the specified consumer. If the consumer was deleted succesfully the endpoint will return a 204 response indicating that the resource did not exist.
Path Parameters
The unique identifier or the username of the Consumer to retrieve.
Example:e94215b0-9198-42ce-bf0b-98afff31b2a7
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted Consumer or the resource didn’t exist
Authentication
Path Parameters
Get a Consumer
Retrieve the details of a specific consumer in the system using either the consumer ID or the consumer username. If the consumer with the specified ID or username cannot be found, the endpoint will return a 404.
Query Parameters
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
Number of resources to be returned.
Default:100
>= 1<= 1000
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The unique identifier or the username of the Consumer to retrieve.
Example:e94215b0-9198-42ce-bf0b-98afff31b2a7
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
New consumer created response
Unix epoch when the resource was created.
Example:1684424758
Field for the unique consumer ID
The unique id of the consumer.
Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27
An optional set of strings associated with the Consumer for grouping and filtering.
Unix epoch when the resource was updated.
Example:1684424758
The unique username of the consumer.
Authentication
Path Parameters
Query Parameters
Update a Consumer
Create or Update Consumer using ID or username. The consumer will be identified via the username or id attribute.If the consumer with the specified ID or username cannot be found, the endpoint will return a 404.
When the username or id attribute has the structure of a UUID, the Consumer being inserted/replaced will be identified by its id. Otherwise it will be identified by its username.
When creating a new Consumer without specifying id (neither in the URL nor in the body), then it will be auto-generated.
Notice that specifying a username in the URL and a different one in the request body is not allowed.
Path Parameters
The unique identifier or the username of the Consumer to retrieve.
Example:e94215b0-9198-42ce-bf0b-98afff31b2a7
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
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
application/json
Response
The consumer object response body
Show Child Parameters
Pagination information
Example:http://localhost:8001/consumers?offset=6378122c-a0a1-438d-a5c6-efabae9fb969