User Identities

The user_identity Object

Represents a user identity associated with an application user account.

A user identity resource.

{
  "created_at": "2025-06-16T16:54:17.946546Z",
  "display_name": "Jane Doe",
  "email_address": "[email protected]",
  "errors": [],
  "full_name": "Jane Doe",
  "phone_number": "+1555551002",
  "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"
}

Properties

acs_user_ids List of UUIDs

Array of access system user IDs associated with the user identity.

created_at Datetime

Date and time at which the user identity was created.

display_name String

email_address String

Unique email address for the user identity.

errors List of Objects

Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.

The specific structure of each object in this list depends on the value of its error_code field.

Variants:

issue_with_acs_user

Indicates that there is an issue with an access system user associated with this user identity.

acs_system_id UUID

ID of the access system that the user identity is associated with.

acs_user_id UUID

ID of the access system user that has an issue.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

issue_with_acs_user

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

full_name String

phone_number String

Unique phone number for the user identity in E.164 format (for example, +15555550100).

user_identity_id UUID

ID of the user identity.

user_identity_key String

Unique key for the user identity.

warnings List of Objects

Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.

The specific structure of each object in this list depends on the value of its warning_code field.

Variants:

being_deleted

Indicates that the user identity is currently being deleted.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

being_deleted

acs_user_profile_does_not_match_user_identity

Indicates that the ACS user's profile does not match the user identity's profile

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

acs_user_profile_does_not_match_user_identity

workspace_id UUID

ID of the workspace that contains the user identity.

Errors

issue_with_acs_user

Indicates that there is an issue with an access system user associated with this user identity.

Warnings

acs_user_profile_does_not_match_user_identity

Indicates that the ACS user's profile does not match the user identity's profile

being_deleted

Indicates that the user identity is currently being deleted.

Endpoints

/user_identities/add_acs_user

Adds a specified access system user to a specified user identity.

/user_identities/create

Creates a new user identity.

/user_identities/delete

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

/user_identities/generate_instant_key

Generates a new instant key for a specified user identity.

/user_identities/get

Returns a specified user identity.

/user_identities/grant_access_to_device

Grants a specified user identity access to a specified device.

/user_identities/list

Returns a list of all user identities.

/user_identities/list_accessible_devices

Returns a list of all devices associated with a specified user identity.

/user_identities/list_acs_systems

Returns a list of all access systems associated with a specified user identity.