Create a new Consumer

Create a new Consumer

post

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

Body

application/json

Description of the new Consumer for creation

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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

custom_idstring

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.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

usernamestring

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

Response

application/json

Successfully created 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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

custom_idstring

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.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

usernamestring

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

post/control-planes/{controlPlaneId}/core-entities/consumers

Body

{ "custom_id": "4200", "id": "8a388226-80e8-4027-a486-25e4f7db5d21", "tags": [ "silver-tier" ], "username": "bob-the-builder" }
 
application/json

Delete a Consumer

Delete a Consumer

delete

Path Parameters

ConsumerIdstringrequired

ID of the Consumer to lookup

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

controlPlaneIdstring(uuid)required

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

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

Response

Successfully deleted Consumer or the resource didn’t exist

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

Get a Consumer

Get a Consumer using ID or username.

get

Path Parameters

ConsumerIdstringrequired

ID of the Consumer to lookup

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

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

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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

custom_idstring

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.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

usernamestring

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

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

Upsert a Consumer

Create or Update Consumer using ID or username.

put

Path Parameters

ConsumerIdstringrequired

ID of the Consumer to lookup

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

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

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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

custom_idstring

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.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

usernamestring

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

Response

application/json

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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

custom_idstring

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.

idstring

A string representing a UUID (universally unique identifier).

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

usernamestring

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

put/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}

Body

{ "custom_id": "4200", "id": "8a388226-80e8-4027-a486-25e4f7db5d21", "tags": [ "silver-tier" ], "username": "bob-the-builder" }
 
application/json

Remove consumer from all consumer groups

Removes a consumer from all Consumer Groups. This operation does not delete the consumer group.

delete

Path Parameters

ConsumerIdstringrequired

ID of the Consumer to lookup

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

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/consumers/{ConsumerId}/consumer_groups