Keys

Uses: Kong Gateway Admin API decK Konnect API

What is a Key?

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

Keys currently support JWK and PEM formats. Both formats carry the same base information, such as the public and private keys, but may allow you to specify additional meta information. For example, the JWK format carries more information than PEM. One key pair can have multiple different representations (JWK or PEM) while being the same key.

Schema

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

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

Hide Child Parameters
private_keystring
public_keystring
setobject

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

Hide Child Parameters
idstring
tagsarray[string]

An optional set of strings associated with the Key for grouping and filtering.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

Set up a Key

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!