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

POSThttps://connect.getseam.com/user_identities/delete

Authorization

api_keypat_with_workspaceconsole_session

Body

application/json

user_identity_id*string (uuid)

Response

200400401

OK

Body

application/json

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://connect.getseam.com/user_identities/delete', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200

{
  "ok": false
}

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

_, uErr := client.UserIdentities.Delete(context.Background(), &api.UserIdentitiesDeleteRequest{
  UserIdentityId: "44d48b20-0dbe-419d-91ca-ab8bceecd135"
})

if uErr != nil {
  return uErr
}

return nil

Response

Returns a Boolean ok status indicator.

Sample Response

JSON

{
  "ok": true
}