List User Identities

• Request Parameters

• Response

• Examples

Returns a list of all user identities.

JavaScript

Returns a list of all user identities.

Code:

await seam.userIdentities.list();

Output:

[
  {
    "created_at": "2025-06-16T16:54:17.946546Z",
    "display_name": "Jane Doe",
    "email_address": "[email protected]",
    "errors": [],
    "full_name": "Jane Doe",
    "phone_number": "[phone]",
    "user_identity_id": "43947360-cdc8-4db6-8b22-e079416d1d8b",
    "user_identity_key": "jane_doe",
    "warnings": [],
    "workspace_id": "b7e0a4e0-1044-4319-9a0b-42b642b68c7f"
  }
]

cURL

Python

Ruby

PHP

Seam CLI

Authentication Methods

• API key

• Client session token

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

To learn more, see Authentication.

Request Parameters

created_before String

Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.

---

credential_manager_acs_system_id String

acs_system_id of the credential manager by which you want to filter the list of user identities.

---

limit Number

Maximum number of records to return per page.

---

page_cursor String

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

---

search String

String for which to search. Filters returned user identities to include all records that satisfy a partial match using full_name, phone_number, email_address or user_identity_id.

---

user_identity_ids Array of UUIDs

Array of user identity IDs by which to filter the list of user identities.

---

Response

Returns: Array of user_identitys

JSON

{
  "created_at": "2025-06-16T16:54:17.946546Z",
  "display_name": "Jane Doe",
  "email_address": "[email protected]",
  "errors": [],
  "full_name": "Jane Doe",
  "phone_number": "[phone]",
  "user_identity_id": "43947360-cdc8-4db6-8b22-e079416d1d8b",
  "user_identity_key": "jane_doe",
  "acs_user_ids": ["0fc82df4-391b-4d00-a234-86378f1c3952"],
  "warnings": [],
  "workspace_id": "b7e0a4e0-1044-4319-9a0b-42b642b68c7f"
}

---

Examples

List user identities for a credential manager

Returns a list of all user identities for a specified credential manager.

JavaScript

Code:

await seam.userIdentities.list({
  credential_manager_acs_system_id: "10698917-8527-4137-92ff-f1ce291bc287",
});

Output:

[
  {
    "created_at": "2025-06-16T16:54:17.946546Z",
    "display_name": "Jane Doe",
    "email_address": "[email protected]",
    "errors": [],
    "full_name": "Jane Doe",
    "phone_number": "[phone]",
    "user_identity_id": "43947360-cdc8-4db6-8b22-e079416d1d8b",
    "user_identity_key": "jane_doe",
    "warnings": [],
    "workspace_id": "b7e0a4e0-1044-4319-9a0b-42b642b68c7f"
  }
]

cURL

Python

Ruby

PHP

Seam CLI