ListKongPrincipals

object
metaobjectrequired
Show Child Parameters
dataarray[object]required

A principal represents an authenticated identity within a directory.
Principals can be associated with API keys and inherit metadata from their parent directory.

Show Child Parameters
Example

ListKongPrincipalKeys

object
metaobjectrequired
Show Child Parameters
dataarray[object]required
Show Child Parameters
Example

KongPrincipalKey

object
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

expires_atstring(date-time)required

An ISO-8601 timestamp representation of entity expiration date.

Example:2022-11-04T20:10:06.927Z

Example

KongPrincipalKeyWithSecret

object
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

expires_atstring(date-time)required

An ISO-8601 timestamp representation of entity expiration date.

Example:2022-11-04T20:10:06.927Z

secretstringrequired

The API key secret value. This is only returned when the key is first created
and cannot be retrieved again later.

Example

DirectoryTTLSecs

integer

The time in seconds that a principal will be cached in memory on a running Gateway if it is
successfully authenticated from this directory. Maximum is 86400 seconds (24 hours).

Default:600

>= 300<= 86400