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

Update an identity

Partially updates an existing principal identity by modifying only the provided fields.
Unspecified fields will retain their current values.

patch

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 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.

issuerstring

The issuer URL. Applicable to oidc type identities.

claimobject
Show Child Parameters
auth_server_idstring(uuid)

The auth server ID. Applicable to auth_server_client type identities.

client_idstring

The client ID. Applicable to auth_server_client type identities.

control_plane_idstring

The control plane ID. Applicable to control_plane_consumer type identities.

consumer_idstring

The consumer ID. Applicable to control_plane_consumer type identities.

keystring

The key. Applicable to custom type identities.

valuestring

The value. Applicable to custom type identities.

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
patch/directories/{directoryId}/principals/{principalId}/identities/{identityId}

Body

{}
 
application/json

Delete an identity

Permanently deletes an identity association from the principal.
This operation cannot be undone.

delete

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

Success

delete/directories/{directoryId}/principals/{principalId}/identities/{identityId}