Skip to main content

The user_identity Object

Represents a user identity associated with an application user account.

Properties

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