/** * Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */ export type UserIdentity = { /** * Array of access system user IDs associated with the user identity. */ acs_user_ids: Array; /** * Date and time at which the user identity was created. */ created_at: string; /** * Display name for the user identity. */ display_name: string; /** * Unique email address for the user identity. */ email_address: string | null; /** * 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. */ errors: Array< /** * Indicates that there is an issue with an access system user associated with this user identity. */ { /** * ID of the access system that the user identity is associated with. */ acs_system_id: string; /** * ID of the access system user that has an issue. */ acs_user_id: string; /** * Date and time at which Seam created the error. */ created_at: string; /** * Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'issue_with_acs_user'; /** * Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string; }>; /** * Full name of the user associated with the user identity. */ full_name: string | null; /** * Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null; /** * ID of the user identity. */ user_identity_id: string; /** * Unique key for the user identity. */ user_identity_key: string | null; /** * 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. */ warnings: Array< /** * Indicates that the user identity is currently being deleted. */ { /** * Date and time at which Seam created the warning. */ created_at: string; /** * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string; /** * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'being_deleted'; } /** * Indicates that the ACS user's profile does not match the user identity's profile */ | { /** * Date and time at which Seam created the warning. */ created_at: string; /** * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string; /** * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'acs_user_profile_does_not_match_user_identity'; }>; /** * ID of the workspace that contains the user identity. */ workspace_id: string; };