Delete a User Identity

Delete a specified user identity

Deletes a specified user identity. To delete a user identity, you must first delete any ACS credentials and enrollment automations associated with the user identity. You must also deactivate any associated phones.

/user_identities/delete

post

Deletes a specified user identity. This deletes the user identity and all associated resources, including any credentials, acs users and client sessions.

Authorizations

api_keypat_with_workspaceconsole_session_with_workspace

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

user_identity_idstring · uuidRequired

ID of the user identity that you want to delete.

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

/user_identities/delete

HTTPcURLJavaScriptPython

POST /user_identities/delete HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "ok": true
}

Request

Specify the desired user identity by including the corresponding user_identity_id in the request body.

Request Body Parameters

Parameter	Type	Description
user_identity_id	String Required	ID of the desired user identity

Sample Request

cURL (bash)

curl -X 'POST' \
  'https://connect.getseam.com/user_identities/delete' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_id": "44d48b20-0dbe-419d-91ca-ab8bceecd135"
}'

Go

Response

Returns a Boolean ok status indicator.

Sample Response

JSON

{
  "ok": true
}