Create a new Consumer
Create a new Consumer
Path Parameters
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 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.
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.
A string representing a UUID (universally unique identifier).
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 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.
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.
A string representing a UUID (universally unique identifier).
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
Delete a Consumer
Delete a Consumer
Path Parameters
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
Response
Successfully deleted Consumer or the resource didn’t exist
Authentication
Path Parameters
Get a Consumer
Get a Consumer using ID or username.
Path Parameters
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.
A string representing a UUID (universally unique identifier).
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
Create or Update Consumer using ID or username.
Path Parameters
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.
A string representing a UUID (universally unique identifier).
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.
A string representing a UUID (universally unique identifier).
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
Removes a consumer from all Consumer Groups. This operation does not delete the consumer group.
Path Parameters
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
Response
Consumer removed from all groups