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.

delete

Path Parameters

ConsumerIdstringrequired

ID of the Consumer to lookup

Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

Consumer removed from all groups

delete/control-planes/{controlPlaneId}/core-entities/{workspace}/consumers/{ConsumerId}/consumer_groups
 

List all Consumer Groups a Consumer belongs to in a workspace

List all Consumer Groups a Consumer belongs to in a workspace

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

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

tagsstring

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

ConsumerIdstringrequired

ID of the Consumer to lookup

Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

A successful response listing Consumer Groups

dataarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/{workspace}/consumers/{ConsumerId}/consumer_groups
 
200 application/json

Add consumer to a specific consumer group in a workspace

Add a consumer to a consumer group in a workspace

post

Path Parameters

ConsumerIdstringrequired

ID of the Consumer to lookup

Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json
groupstring

Example:fedee695-2ae2-4e45-877a-776d9b2fc793

Response

201 application/json

Consumer added to a specific group

consumerobject

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"}

* Additional properties are NOT allowed.
Show Child Parameters
consumer_groupsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
post/control-planes/{controlPlaneId}/core-entities/{workspace}/consumers/{ConsumerId}/consumer_groups

Body

{}
 
201 application/json

Remove consumer from consumer group in a workspace

Removes a consumer from a Consumer Group. This operation does not delete the consumer group in a workspace.

delete

Path Parameters

ConsumerIdstringrequired

ID of the Consumer to lookup

Example:c1059869-6fa7-4329-a5f5-5946d14ca2c5

ConsumerGroupIdstringrequired

ID of the Consumer Group to lookup

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

204

Consumer removed from group

delete/control-planes/{controlPlaneId}/core-entities/{workspace}/consumers/{ConsumerId}/consumer_groups/{ConsumerGroupId}
 
204

List all Consumers

List all Consumers

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

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

tagsstring

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

custom_idstring

Filter consumers by their custom_id.

Example:my-custom-id

filter[name][contains]string

Filter routes by a substring of the name.

Example:john

filter[name][eq]string

Filter routes by their name.

Example:john

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A successful response listing Consumers

dataarray[object]

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"}

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/consumers
 
application/json