Key

object

A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

jwkstring

A JSON Web Key represented as a string.

kidstringrequired

A unique identifier for a key.

namestring

The name to associate with the given keys.

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

The id (an UUID) of the key-set with which to associate the key.

Show Child Parameters
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

X.509 certificate SHA-1 thumbprint.

Example

KeyAuth

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

keystring
tagsarray[string]

A string representing a tag.

ttlinteger

key-auth ttl in seconds

Example

KeyAuthWithoutParents

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

keystring
tagsarray[string]

A string representing a tag.

ttlinteger

key-auth ttl in seconds

Example

KeySet

object
* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestring

The name to associate with the given key-set.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Example

KeyWithoutParents

object

A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

jwkstring

A JSON Web Key represented as a string.

kidstringrequired

A unique identifier for a key.

namestring

The name to associate with the given keys.

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

The id (an UUID) of the key-set with which to associate the key.

Show Child Parameters
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

X.509 certificate SHA-1 thumbprint.

Example