KongPrincipalDescription
stringOptional description providing additional context about the principal’s purpose or role.
<= 255 characters
KongPrincipal
objectA principal represents an authenticated identity within a directory.
Principals can be associated with API keys and inherit metadata from their parent directory.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Human-readable name of the principal.
<= 255 characters
Optional description providing additional context about the principal’s purpose or role.
<= 255 characters
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.
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
KongPrincipalIdentityBody
One OfContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Allowed values:oidc
Show Child Parameters
UpdatePrincipalIdentityBody
objectRequest body for partially updating a principal identity.
The identity type cannot be changed. All fields are optional;
only the fields relevant to the existing identity type will be applied.
The issuer URL. Applicable to oidc type identities.
Show Child Parameters
The auth server ID. Applicable to auth_server_client type identities.
The client ID. Applicable to auth_server_client type identities.
The control plane ID. Applicable to control_plane_consumer type identities.
The consumer ID. Applicable to control_plane_consumer type identities.
The key. Applicable to custom type identities.
The value. Applicable to custom type identities.
KongPrincipalIdentityBase
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z