ConsumerGroups

array

A list of consumer groups that the Consumer is in.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.

CreatedAt

string

An ISO-8601 timestamp representation of entity creation date.

Example

UpdatedAt

string

An ISO-8601 timestamp representation of entity update date.

Example

CentralizedConsumer

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.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The Consumer ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

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.

typestringrequired

Type of the consumer.

Allowed values:proxydeveloperadminapplication

Default:proxy

tagsarray[string]requiredunique-items
consumer_groupsarray[string]requiredunique-items

A list of consumer groups that the Consumer is in.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

UUID

string

Contains a unique identifier used for this resource.

Example