ConsumerCreateRequest

object
* Additional properties are NOT allowed.
usernamestringrequired

The unique username of the Consumer.

>= 1 characters

custom_idstring

Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database.

>= 1 characters

consumer_groupsarray[string]unique-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.

typestring

Type of the consumer.

Allowed values:proxydeveloperadminapplication

Default:proxy

tagsarray[string]unique-items
Example

AllowedControlPlanes

array

List of control plane ids that are allowed to use the realm. This is used when allow_all_control_planes value
is set to false.

ConsumerType

string

Type of the consumer.

Allowed values:proxydeveloperadminapplication

Default:proxy

Tags

array

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.