Get a Consumer in a workspace
Get a Consumer using ID or username in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
ID of the Consumer to lookup
Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched Consumer
Consumer
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.
Unix epoch when the resource was created.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
A string representing a tag.
Unix epoch when the resource was last updated.
The unique username of the Consumer. You must send either this field or custom_id with the request.
Authentication
Path Parameters
Upsert a Consumer in a workspace
Create or Update Consumer using ID or username in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
ID of the Consumer to lookup
Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the Consumer
Consumer
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.
Unix epoch when the resource was created.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
A string representing a tag.
Unix epoch when the resource was last updated.
The unique username of the Consumer. You must send either this field or custom_id with the request.
Response
application/json
Response
Successfully upserted Consumer
Consumer
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.
Unix epoch when the resource was created.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
A string representing a tag.
Unix epoch when the resource was last updated.
The unique username of the Consumer. You must send either this field or custom_id with the request.
Authentication
Path Parameters
Body
Remove consumer from all consumer groups in a workspace
Removes a consumer from all Consumer Groups. This operation does not delete the consumer group in a workspace.
Path Parameters
ID of the Consumer to lookup
Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Consumer removed from all groups
Authentication
Path Parameters
List all Consumer Groups a Consumer belongs to in a workspace
List all Consumer Groups a Consumer belongs to in a workspace
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
ID of the Consumer to lookup
Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing Consumer Groups
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Add consumer to a specific consumer group in a workspace
Add a consumer to a consumer group in a workspace
Path Parameters
ID of the Consumer to lookup
Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Example:fedee695-2ae2-4e45-877a-776d9b2fc793
Response
201 application/json
Response
Consumer added to a specific group
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","tags":["silver-tier"],"username":"bob-the-builder"}