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}
 

AllowedControlPlanes

array

List of control plane IDs authorized to make authentication requests to this directory.
Maximum of 32 control planes can be specified. Use allow_all_control_planes for unrestricted access.

Default:[]

KongDirectoryRealmValues

object

Configuration values used when a Kong v3 data plane connects to identity as realm. The directory is used as a realm for regional consumers.

ttlintegerrequired

The time in minutes that the Consumer will be cached in memory on a running Gateway if it is
successfully loaded from Konnect.

Default:10

>= 5

negative_ttlintegerrequired

If a running Gateway triggers a lookup for a Consumer that cannot be authenticated this realm, a negative_ttl
is set. The Gateway will not try to lookup the Consumer in Konnect for negative_ttl minutes.

A Consumer will be cached for negative_ttl if they do not exist in the Realm, or if the provided credentials
are invalid.

Default:10

>= 5

consumer_groupsarray[string](set)requiredunique-items

A list of consumer groups to automatically add to any consumers created within this Realm.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.

Example

AllowAllControlPlanes

boolean

When set to true, all control planes within the organization can make authentication requests to this directory.
This overrides the allowed_control_planes list. Defaults to false for security.

Default:false