Skip to main content

​
The user_identity Object

Represents a user identity associated with an application user account.

​
Properties

​
acs_user_ids
Array
Array of access system user IDs associated with the user identity.
​
created_at
String (ISO 8601)
Date and time at which the user identity was created.
​
display_name
String
Display name for the user identity.
​
email_address
String
Unique email address for the user identity.
​
errors
Array
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.
​
full_name
String
Full name of the user associated with the user identity.
​
phone_number
String
Unique phone number for the user identity in E.164 format (for example, +15555550100).
​
user_identity_id
String (UUID)
ID of the user identity.
​
user_identity_key
String
Unique key for the user identity.
​
warnings
Array
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.
​
workspace_id
String (UUID)
ID of the workspace that contains the user identity.