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

DirectoryName

string

Human-readable name of the directory, used to identify the organizational boundary.
A directory name is unique within the organization.

Match pattern:^[a-z0-9-_]+$

>= 1 characters<= 255 characters