Delete a User Identity

• Request Parameters

• Response

• Examples

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

Signature

POST /user_identities/delete ⇒ void

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

user_identity_id String (Required)

ID of the desired user identity.

---

Response

void

---

Examples

Delete a user identity

Specify the desired user_identity_id.

JavaScript

Code

await seam.userIdentities.delete({
  user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135",
});

Output

// void

Python

Code

seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135")

Output

None

Ruby

Code

seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135")

Output

nil

PHP

Code

<?php
$seam->user_identities->delete(
    user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135"
);

Output

null

Seam CLI

Code

seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135"

Output

{}

Go

Code

package main

import api "github.com/seamapi/go"

func main() {
	client.UserIdentities.Delete(
		context.Background(),
		api.UserIdentitiesDeleteRequest{
			UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"),
		},
	)
}

Output

nil

cURL

Code

curl --include --request POST "https://connect.getseam.com/user_identities/delete" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "user_identity_id": "44d48b20-0dbe-419d-91ca-ab8bceecd135"
}
EOF

Output

{}