Consumers

Consumers

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.

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

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

200 application/json

New consumer created response

created_atinteger

Unix epoch when the resource was created.

Example:1684424758

custom_idstring

Field for the unique consumer ID

idstring

The unique id of the consumer.

Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27

tagsarray[string]

An optional set of strings associated with the Consumer for grouping and filtering.

updated_atinteger

Unix epoch when the resource was updated.

Example:1684424758

usernamestring

The unique username of the consumer.

get/runtime-groups/{runtimeGroupId}/core-entities/consumers
 
200 application/json

Create a new Consumer

Create a new Consumer

post

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Body

application/json

Consumer request body

usernamestringrequired

The unique username of the Consumer. You must send either this field or custom_id with the request.

custom_idstringrequired

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.

tagsarray[string]

An optional set of strings associated with the Consumer for grouping and filtering.

Response

application/json

New consumer created response

created_atinteger

Unix epoch when the resource was created.

Example:1684424758

custom_idstring

Field for the unique consumer ID

idstring

The unique id of the consumer.

Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27

tagsarray[string]

An optional set of strings associated with the Consumer for grouping and filtering.

updated_atinteger

Unix epoch when the resource was updated.

Example:1684424758

usernamestring

The unique username of the consumer.

post/runtime-groups/{runtimeGroupId}/core-entities/consumers

Body

{ "username": "username", "custom_id": "custom_id" }
 
application/json

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.

delete

Path Parameters

consumer_idstringrequired

The unique identifier or the username of the Consumer to retrieve.

Example:e94215b0-9198-42ce-bf0b-98afff31b2a7

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

204

Successfully deleted Consumer or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/consumers/{consumer_id}
 
204

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.

get

Query Parameters

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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

consumer_idstringrequired

The unique identifier or the username of the Consumer to retrieve.

Example:e94215b0-9198-42ce-bf0b-98afff31b2a7

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

application/json

New consumer created response

created_atinteger

Unix epoch when the resource was created.

Example:1684424758

custom_idstring

Field for the unique consumer ID

idstring

The unique id of the consumer.

Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27

tagsarray[string]

An optional set of strings associated with the Consumer for grouping and filtering.

updated_atinteger

Unix epoch when the resource was updated.

Example:1684424758

usernamestring

The unique username of the consumer.

get/runtime-groups/{runtimeGroupId}/core-entities/consumers/{consumer_id}
 
application/json