Identities

Batch delete identities.

Changed on

To delete multiple identities in a realm, send a POST request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/identities:batchDelete. The request must contain at least one and no more than 1000 identity IDs. If there are any repeating identity IDs, the request will fail. If there are any invalid identity IDs, the request will fail and no identities will be deleted. A successful request will receive a 200 status code with no body in the response. This indicates that the request was processed successfully.

post/v1/tenants/{tenant_id}/realms/{realm_id}/identities:batchDelete

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Request body

idsstring[] required

IDs of the identities to be deleted.

Response

The action was successful and the response body is empty.

Changes