Consumer

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

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
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.

Example

ConsumerGroup

object
* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestringrequired

The name of the consumer group.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Example

ConsumerGroupInsideWrapper

object
consumer_groupobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

CustomPlugin

object
* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

handlerstringrequired

The handler for the given custom plugin.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestringrequired

The name to associate with the given custom plugin.

schemastringrequired

The schema for the given custom plugin.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Example

Degraphql_route

object
* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

Default:GET

querystringrequired
serviceobjectrequired
Show Child Parameters
updated_atinteger

Unix epoch when the resource was last updated.

uristringrequired
Example