User Identities

The user_identity Object

Represents a associated with an application user account.

Properties

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 two fields: "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.

Child Object Properties

created_at Datetime

Date and time at which Seam created the error.

message String

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

full_name String

phone_number String

user_identity_id UUID

ID of the user identity.

user_identity_key String

Unique key for the user identity.

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

workspace_id UUID

Warnings

being_deleted

Indicates that the user identity is currently being deleted.

Endpoints

PreviousHVAC Mode Adjusted NextCreate a User Identity

Last updated 3 days ago

Was this helpful?