Skip to main content

​
The user_identity Object

Represents a user identity associated with an application user account. 
{
  "created_at": "2025-06-16T16:54:17.946546Z",
  "display_name": "Jane Doe",
  "email_address": "jane@example.com",
  "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
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
The display name.
​
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
The full name.
​
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.