UpdatePrincipalBody

object
display_namestring

Human-readable name of the principal.

<= 255 characters

descriptionstring

Optional description providing additional context about the principal’s purpose or role.

<= 255 characters

metadataobject

A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane
to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical
manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials.

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example

CreatePrincipalKeyBody

object
One Of
typestringrequired

Allowed values:imported

secretstringrequired

>= 1 characters<= 255 characters

expires_atstring(date-time)

An ISO-8601 timestamp representation of entity expiration date.

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

Example

CreatePrincipalKeyBodyImported

* Additional properties are NOT allowed.
typestringrequired

Allowed values:imported

secretstringrequired

>= 1 characters<= 255 characters

expires_atstring(date-time)

An ISO-8601 timestamp representation of entity expiration date.

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

Example

CreatePrincipalKeyBodyv1

* Additional properties are NOT allowed.
typestringrequired

Allowed values:v1

expires_atstring(date-time)

An ISO-8601 timestamp representation of entity expiration date.

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

Example

UpdatePrincipalKeyBody

object

Request body for updating an API key’s metadata

expires_atstring(date-time)

An ISO-8601 timestamp representation of entity expiration date.

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

Example