@seamapi/http - v2.0.0
    Preparing search index...

    Type Alias UnmanagedUserIdentity

    Represents an unmanaged user identity. Unmanaged user identities do not have keys.

    type UnmanagedUserIdentity = {
        acs_user_ids: string[];
        created_at: string;
        display_name: string;
        email_address: string | null;
        errors: {
            acs_system_id: string;
            acs_user_id: string;
            created_at: string;
            error_code: "issue_with_acs_user";
            message: string;
        }[];
        full_name: string
        | null;
        phone_number: string | null;
        user_identity_id: string;
        warnings: (
            | {
                created_at: string;
                message: string;
                warning_code: "being_deleted";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "acs_user_profile_does_not_match_user_identity";
            }
        )[];
        workspace_id: string;
    }
    Index
    acs_user_ids created_at display_name email_address errors full_name phone_number user_identity_id warnings workspace_id
    acs_user_ids: string[]

    Array of access system user IDs associated with the user identity.

    created_at: string

    Date and time at which the user identity was created.

    display_name: string

    Display name for the user identity.

    email_address: string | null

    Unique email address for the user identity.

    errors: {
        acs_system_id: string;
        acs_user_id: string;
        created_at: string;
        error_code: "issue_with_acs_user";
        message: string;
    }[]

    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.

    Type Declaration

    • acs_system_id: string

      ID of the access system that the user identity is associated with.

    • acs_user_id: string

      ID of the access system user that has an issue.

    • created_at: string

      Date and time at which Seam created the error.

    • error_code: "issue_with_acs_user"

      Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

    • message: string

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

    full_name: string | null

    Full name of the user associated with the user identity.

    phone_number: string | null

    Unique phone number for the user identity in E.164 format (for example, +15555550100).

    user_identity_id: string

    ID of the user identity.

    warnings: (
        | { created_at: string; message: string; warning_code: "being_deleted" }
        | {
            created_at: string;
            message: string;
            warning_code: "acs_user_profile_does_not_match_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.

    Type Declaration

    • { created_at: string; message: string; warning_code: "being_deleted" }
      • created_at: string

        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: "being_deleted"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    • {
          created_at: string;
          message: string;
          warning_code: "acs_user_profile_does_not_match_user_identity";
      }
      • created_at: string

        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: "acs_user_profile_does_not_match_user_identity"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    workspace_id: string

    ID of the workspace that contains the user identity.

    Settings
    Member Visibility

    On This Page
    Properties