BasicAuthWithoutParents

object
* Additional properties are NOT allowed.
consumerobject
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

passwordstringrequired
tagsarray[string]

A string representing a tag.

usernamestringrequired
Example

CACertificate

object

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate.

* Additional properties are NOT allowed.
certstringrequired

PEM-encoded public certificate of the CA.

cert_digeststring

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_atinteger

Unix epoch when the resource was created.

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.

Example

Certificate

object

A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service. Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames. If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string according to the following order: main certificate on the top, followed by any intermediates.

* Additional properties are NOT allowed.
certstringrequired

PEM-encoded public certificate chain of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

cert_altstring

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

keystringrequired

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

key_altstring

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

snisarray[string]

A string representing a wildcard host name, such as *.example.com.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Example

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.

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.

Example

ConsumerGroup

object
* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

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