List all identities for a principal
Retrieves a paginated list of all identities associated with the specified principal.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Response
application/json
Response
List of principal identities
ListKongPrincipalIdentities
Show Child Parameters
One OfShow Child Parameters
Authentication
Path Parameters
Query Parameters
Create an identity for a principal
Creates a new identity association for the specified principal.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Body
application/json
Body
Identity to be created
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
Response
application/json
Response
A principal identity
KongPrincipalIdentity
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
Authentication
Path Parameters
Body
Get an identity
Retrieves detailed information about a specific principal identity by its ID.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the principal identity (UUID format)
Response
application/json
Response
A principal identity
KongPrincipalIdentity
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
Authentication
Path Parameters
Replace an identity
Completely replaces an existing principal identity with the provided data.
All fields must be specified; any omitted fields will be reset to their defaults.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the principal identity (UUID format)
Body
application/json
Body
Identity to be replaced
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
Response
application/json
Response
A principal identity
KongPrincipalIdentity
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
Authentication
Path Parameters
Body
Update an identity
Partially updates an existing principal identity by modifying only the provided fields.
Unspecified fields will retain their current values.
Path Parameters
ID of the directory
Unique identifier of the principal (UUID format)
Unique identifier of the principal identity (UUID format)
Body
application/json
Body
Identity to be partially updated
UpdatePrincipalIdentityBody
Request 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.
Response
application/json
Response
A principal identity
KongPrincipalIdentity
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