Get a User Identity

POST /user_identities/get ⇒ { user_identity }

Returns a specified user identity.

JavaScript

Request

await seam.userIdentities.get({
  user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
});

Response

{
  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
  "user_identity_key": "jean_doe",
  "email_address": "[email protected]",
  "phone_number": "[phone]",
  "display_name": "Jean Doe",
  "full_name": "Jean Doe",
  "created_at": "2024-01-11T05:37:50.264Z",
  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
}

Python

Ruby

PHP

Seam CLI

Go

Authentication Methods

• API key

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

Request Parameters

user_identity_id

Type: string Required: No

ID of the desired user identity.

---

user_identity_key

Type: string Required: No

---

Return Type

user_identity