KongPrincipalIdentity

Identities represent external authentication associations for a principal. Each identity links a principal
to an external system such as an OIDC provider, an auth server client, a control plane consumer, or a custom identifier.

List all identities for a principal

Retrieves a paginated list of all identities associated with the specified principal.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

Response

application/json

List of principal identities

ListKongPrincipalIdentities

metaobjectrequired
Show Child Parameters
dataOne Of
arrayrequired
KongPrincipalIdentityOIDCResponseobject
Show Child Parameters
get/directories/{directoryId}/principals/{principalId}/identities
 
application/json

Create an identity for a principal

Creates a new identity association for the specified principal.

post

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

Body

application/json

Identity to be created

KongPrincipalIdentityBody

KongPrincipalIdentityBody
One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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"}

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

typestringrequired

Allowed values:oidc

issuerstringrequired
claimobjectrequired
Show Child Parameters

Response

application/json

A principal identity

KongPrincipalIdentity

KongPrincipalIdentity
One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

labelsobjectrequired

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"}

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

typestringrequired

Allowed values:oidc

issuerstringrequired
claimobjectrequired
Show Child Parameters
post/directories/{directoryId}/principals/{principalId}/identities

Body

{}
 
application/json

Get an identity

Retrieves detailed information about a specific principal identity by its ID.

get

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

identityIdstring(uuid)required

Unique identifier of the principal identity (UUID format)

Response

application/json

A principal identity

KongPrincipalIdentity

KongPrincipalIdentity
One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

labelsobjectrequired

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"}

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

typestringrequired

Allowed values:oidc

issuerstringrequired
claimobjectrequired
Show Child Parameters
get/directories/{directoryId}/principals/{principalId}/identities/{identityId}
 
application/json

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.

put

Path Parameters

directoryIdstring(uuid)required

ID of the directory

principalIdstring(uuid)required

Unique identifier of the principal (UUID format)

identityIdstring(uuid)required

Unique identifier of the principal identity (UUID format)

Body

application/json

Identity to be replaced

KongPrincipalIdentityBody

KongPrincipalIdentityBody
One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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"}

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

typestringrequired

Allowed values:oidc

issuerstringrequired
claimobjectrequired
Show Child Parameters

Response

application/json

A principal identity

KongPrincipalIdentity

KongPrincipalIdentity
One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

labelsobjectrequired

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"}

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

typestringrequired

Allowed values:oidc

issuerstringrequired
claimobjectrequired
Show Child Parameters
put/directories/{directoryId}/principals/{principalId}/identities/{identityId}

Body

{}
 
application/json