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

    Type Alias AcsUser

    Represents a user in an access system.

    An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.

    For details about how to configure users in your access system, see the corresponding system integration guide.

    type AcsUser = {
        access_schedule?: { ends_at: string | null; starts_at: string };
        acs_system_id: string;
        acs_user_id: string;
        connected_account_id: string;
        created_at: string;
        display_name: string;
        email?: string;
        email_address?: string;
        errors: (
            | {
                created_at: string;
                error_code: "deleted_externally";
                message: string;
            }
            | {
                created_at: string;
                error_code: "salto_ks_subscription_limit_exceeded";
                message: string;
            }
            | {
                created_at: string;
                error_code: "failed_to_create_on_acs_system";
                message: string;
            }
            | {
                created_at: string;
                error_code: "failed_to_update_on_acs_system";
                message: string;
            }
            | {
                created_at: string;
                error_code: "failed_to_delete_on_acs_system";
                message: string;
            }
            | {
                created_at: string;
                error_code: "latch_conflict_with_resident_user";
                message: string;
            }
        )[];
        external_type?: | "pti_user"
        | "brivo_user"
        | "hid_credential_manager_user"
        | "salto_site_user"
        | "latch_user"
        | "dormakaba_community_user"
        | "salto_space_user"
        | "avigilon_alta_user"
        | "kisi_user";
        external_type_display_name?: string;
        full_name?: string;
        hid_acs_system_id?: string;
        is_managed: boolean;
        is_suspended?: boolean;
        pending_mutations?: (
            | { created_at: string; message: string; mutation_code: "creating" }
            | { created_at: string; message: string; mutation_code: "deleting" }
            | {
                created_at: string;
                message: string;
                mutation_code: "deferring_creation";
                scheduled_at?: string | null;
            }
            | {
                created_at: string;
                from: {
                    email_address?: string
                    | null;
                    full_name?: string | null;
                    phone_number?: string | null;
                };
                message: string;
                mutation_code: "updating_user_information";
                to: {
                    email_address?: string
                    | null;
                    full_name?: string | null;
                    phone_number?: string | null;
                };
            }
            | {
                created_at: string;
                from: { ends_at: string
                | null; starts_at: string | null };
                message: string;
                mutation_code: "updating_access_schedule";
                to: { ends_at: string | null; starts_at: string | null };
            }
            | {
                created_at: string;
                from: { is_suspended: boolean };
                message: string;
                mutation_code: "updating_suspension_state";
                to: { is_suspended: boolean };
            }
            | {
                created_at: string;
                from: { acs_access_group_id: string
                | null };
                message: string;
                mutation_code: "updating_group_membership";
                to: { acs_access_group_id: string | null };
            }
            | {
                acs_access_group_id: string;
                created_at: string;
                message: string;
                mutation_code: "deferring_group_membership_update";
                variant: "adding"
                | "removing";
            }
            | {
                created_at: string;
                from: { acs_credential_id: string
                | null };
                message: string;
                mutation_code: "updating_credential_assignment";
                to: { acs_credential_id: string | null };
            }
        )[];
        phone_number?: string;
        salto_ks_metadata?: { is_subscribed?: boolean };
        salto_space_metadata?: { audit_openings?: boolean; user_id?: string };
        user_identity_email_address?: string | null;
        user_identity_full_name?: string | null;
        user_identity_id?: string;
        user_identity_phone_number?: string | null;
        warnings: (
            | {
                created_at: string;
                message: string;
                warning_code: "being_deleted";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "salto_ks_user_not_subscribed";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "acs_user_inactive";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "unknown_issue_with_acs_user";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "latch_resident_user";
            }
        )[];
        workspace_id: string;
    }
    Index
    access_schedule? acs_system_id acs_user_id connected_account_id created_at display_name email? email_address? errors external_type? external_type_display_name? full_name? hid_acs_system_id? is_managed is_suspended? pending_mutations? phone_number? salto_ks_metadata? salto_space_metadata? user_identity_email_address? user_identity_full_name? user_identity_id? user_identity_phone_number? warnings workspace_id
    access_schedule?: { ends_at: string | null; starts_at: string }

    starts_at and ends_at timestamps for the access system user's access.

    Type Declaration

    • ends_at: string | null

      Date and time at which the user's access ends, in ISO 8601 format.

    • starts_at: string

      Date and time at which the user's access starts, in ISO 8601 format.

    acs_system_id: string

    ID of the access system that contains the access system user.

    acs_user_id: string

    ID of the access system user.

    connected_account_id: string

    The ID of the connected account that is associated with the access system user.

    created_at: string

    Date and time at which the access system user was created.

    display_name: string

    Display name for the access system user.

    email?: string

    use email_address.

    email_address?: string

    Email address of the access system user.

    errors: (
        | {
            created_at: string;
            error_code: "deleted_externally";
            message: string;
        }
        | {
            created_at: string;
            error_code: "salto_ks_subscription_limit_exceeded";
            message: string;
        }
        | {
            created_at: string;
            error_code: "failed_to_create_on_acs_system";
            message: string;
        }
        | {
            created_at: string;
            error_code: "failed_to_update_on_acs_system";
            message: string;
        }
        | {
            created_at: string;
            error_code: "failed_to_delete_on_acs_system";
            message: string;
        }
        | {
            created_at: string;
            error_code: "latch_conflict_with_resident_user";
            message: string;
        }
    )[]

    Errors associated with the access system user.

    Type Declaration

    • { created_at: string; error_code: "deleted_externally"; message: string }
      • created_at: string

        Date and time at which Seam created the error.

      • error_code: "deleted_externally"
      • message: string

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

    • {
          created_at: string;
          error_code: "salto_ks_subscription_limit_exceeded";
          message: string;
      }
      • created_at: string

        Date and time at which Seam created the error.

      • error_code: "salto_ks_subscription_limit_exceeded"
      • message: string

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

    • {
          created_at: string;
          error_code: "failed_to_create_on_acs_system";
          message: string;
      }
      • created_at: string

        Date and time at which Seam created the error.

      • error_code: "failed_to_create_on_acs_system"
      • message: string

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

    • {
          created_at: string;
          error_code: "failed_to_update_on_acs_system";
          message: string;
      }
      • created_at: string

        Date and time at which Seam created the error.

      • error_code: "failed_to_update_on_acs_system"
      • message: string

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

    • {
          created_at: string;
          error_code: "failed_to_delete_on_acs_system";
          message: string;
      }
      • created_at: string

        Date and time at which Seam created the error.

      • error_code: "failed_to_delete_on_acs_system"
      • message: string

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

    • {
          created_at: string;
          error_code: "latch_conflict_with_resident_user";
          message: string;
      }
      • created_at: string

        Date and time at which Seam created the error.

      • error_code: "latch_conflict_with_resident_user"
      • message: string

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

    external_type?:
        | "pti_user"
        | "brivo_user"
        | "hid_credential_manager_user"
        | "salto_site_user"
        | "latch_user"
        | "dormakaba_community_user"
        | "salto_space_user"
        | "avigilon_alta_user"
        | "kisi_user"

    Brand-specific terminology for the access system user type.

    external_type_display_name?: string

    Display name that corresponds to the brand-specific terminology for the access system user type.

    full_name?: string

    Full name of the access system user.

    hid_acs_system_id?: string

    ID of the HID access control system associated with the user.

    is_managed: boolean

    Indicates whether Seam manages the access system user.

    is_suspended?: boolean

    Indicates whether the access system user is currently suspended.

    pending_mutations?: (
        | { created_at: string; message: string; mutation_code: "creating" }
        | { created_at: string; message: string; mutation_code: "deleting" }
        | {
            created_at: string;
            message: string;
            mutation_code: "deferring_creation";
            scheduled_at?: string | null;
        }
        | {
            created_at: string;
            from: {
                email_address?: string
                | null;
                full_name?: string | null;
                phone_number?: string | null;
            };
            message: string;
            mutation_code: "updating_user_information";
            to: {
                email_address?: string
                | null;
                full_name?: string | null;
                phone_number?: string | null;
            };
        }
        | {
            created_at: string;
            from: { ends_at: string
            | null; starts_at: string | null };
            message: string;
            mutation_code: "updating_access_schedule";
            to: { ends_at: string | null; starts_at: string | null };
        }
        | {
            created_at: string;
            from: { is_suspended: boolean };
            message: string;
            mutation_code: "updating_suspension_state";
            to: { is_suspended: boolean };
        }
        | {
            created_at: string;
            from: { acs_access_group_id: string
            | null };
            message: string;
            mutation_code: "updating_group_membership";
            to: { acs_access_group_id: string | null };
        }
        | {
            acs_access_group_id: string;
            created_at: string;
            message: string;
            mutation_code: "deferring_group_membership_update";
            variant: "adding"
            | "removing";
        }
        | {
            created_at: string;
            from: { acs_credential_id: string
            | null };
            message: string;
            mutation_code: "updating_credential_assignment";
            to: { acs_credential_id: string | null };
        }
    )[]

    Pending mutations associated with the access system user. Seam is in the process of pushing these mutations to the integrated access system.

    Type Declaration

    • { created_at: string; message: string; mutation_code: "creating" }
      • created_at: string

        Date and time at which the mutation was created.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "creating"

        Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system.

    • { created_at: string; message: string; mutation_code: "deleting" }
      • created_at: string

        Date and time at which the mutation was created.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "deleting"

        Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system.

    • {
          created_at: string;
          message: string;
          mutation_code: "deferring_creation";
          scheduled_at?: string | null;
      }
      • created_at: string

        Date and time at which the mutation was created.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "deferring_creation"

        Mutation code to indicate that Seam is intentionally deferring the creation of the user on the access control system until the appropriate time.

      • Optionalscheduled_at?: string | null

        Optional: When the user creation is scheduled to occur.

    • {
          created_at: string;
          from: {
              email_address?: string | null;
              full_name?: string | null;
              phone_number?: string | null;
          };
          message: string;
          mutation_code: "updating_user_information";
          to: {
              email_address?: string
              | null;
              full_name?: string | null;
              phone_number?: string | null;
          };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: {
            email_address?: string | null;
            full_name?: string | null;
            phone_number?: string | null;
        }

        Old access system user information.

        • Optionalemail_address?: string | null

          Email address of the access system user.

        • Optionalfull_name?: string | null

          Full name of the access system user.

        • Optionalphone_number?: string | null

          Phone number of the access system user.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "updating_user_information"

        Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system.

      • to: {
            email_address?: string | null;
            full_name?: string | null;
            phone_number?: string | null;
        }

        New access system user information.

        • Optionalemail_address?: string | null

          Email address of the access system user.

        • Optionalfull_name?: string | null

          Full name of the access system user.

        • Optionalphone_number?: string | null

          Phone number of the access system user.

    • {
          created_at: string;
          from: { ends_at: string | null; starts_at: string | null };
          message: string;
          mutation_code: "updating_access_schedule";
          to: { ends_at: string | null; starts_at: string | null };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: { ends_at: string | null; starts_at: string | null }

        Old access schedule information.

        • ends_at: string | null

          Starting time for the access schedule.

        • starts_at: string | null

          Starting time for the access schedule.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "updating_access_schedule"

        Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.

      • to: { ends_at: string | null; starts_at: string | null }

        New access schedule information.

        • ends_at: string | null

          Starting time for the access schedule.

        • starts_at: string | null

          Starting time for the access schedule.

    • {
          created_at: string;
          from: { is_suspended: boolean };
          message: string;
          mutation_code: "updating_suspension_state";
          to: { is_suspended: boolean };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: { is_suspended: boolean }

        Old user suspension state information.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "updating_suspension_state"

        Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system.

      • to: { is_suspended: boolean }

        New user suspension state information.

    • {
          created_at: string;
          from: { acs_access_group_id: string | null };
          message: string;
          mutation_code: "updating_group_membership";
          to: { acs_access_group_id: string | null };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: { acs_access_group_id: string | null }

        Old access group membership.

        • acs_access_group_id: string | null

          Old access group ID.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "updating_group_membership"

        Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system.

      • to: { acs_access_group_id: string | null }

        New access group membership.

        • acs_access_group_id: string | null

          New access group ID.

    • {
          acs_access_group_id: string;
          created_at: string;
          message: string;
          mutation_code: "deferring_group_membership_update";
          variant: "adding" | "removing";
      }
      • acs_access_group_id: string

        ID of the access group involved in the scheduled change.

      • created_at: string

        Date and time at which the mutation was created.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "deferring_group_membership_update"

        Mutation code to indicate that a scheduled access group membership change is pending for this user.

      • variant: "adding" | "removing"

        Whether the user is scheduled to be added to or removed from the access group.

    • {
          created_at: string;
          from: { acs_credential_id: string | null };
          message: string;
          mutation_code: "updating_credential_assignment";
          to: { acs_credential_id: string | null };
      }
      • created_at: string

        Date and time at which the mutation was created.

      • from: { acs_credential_id: string | null }

        Previous credential assignment.

        • acs_credential_id: string | null

          Previous credential ID.

      • message: string

        Detailed description of the mutation.

      • mutation_code: "updating_credential_assignment"

        Mutation code to indicate that Seam is in the process of assigning or unassigning a credential to the user on the integrated access system.

      • to: { acs_credential_id: string | null }

        New credential assignment.

        • acs_credential_id: string | null

          New credential ID.

    phone_number?: string

    Phone number of the access system user in E.164 format (for example, +15555550100).

    salto_ks_metadata?: { is_subscribed?: boolean }

    Salto KS-specific metadata associated with the access system user.

    Type Declaration

    • Optionalis_subscribed?: boolean

      Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from is_suspended, which reflects whether the user has been explicitly blocked.

    salto_space_metadata?: { audit_openings?: boolean; user_id?: string }

    Salto Space-specific metadata associated with the access system user.

    Type Declaration

    • Optionalaudit_openings?: boolean

      Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.

    • Optionaluser_id?: string

      User ID in the Salto Space access system.

    user_identity_email_address?: string | null

    Email address of the user identity associated with the access system user.

    user_identity_full_name?: string | null

    Full name of the user identity associated with the access system user.

    user_identity_id?: string

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

    user_identity_phone_number?: string | null

    Phone number of the user identity associated with the access system user in E.164 format (for example, +15555550100).

    warnings: (
        | { created_at: string; message: string; warning_code: "being_deleted" }
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_user_not_subscribed";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "acs_user_inactive";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "unknown_issue_with_acs_user";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "latch_resident_user";
        }
    )[]

    Warnings associated with the access system user.

    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"
    • {
          created_at: string;
          message: string;
          warning_code: "salto_ks_user_not_subscribed";
      }
      • 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: "salto_ks_user_not_subscribed"
    • { created_at: string; message: string; warning_code: "acs_user_inactive" }
      • 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_inactive"
    • {
          created_at: string;
          message: string;
          warning_code: "unknown_issue_with_acs_user";
      }
      • 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: "unknown_issue_with_acs_user"
    • { created_at: string; message: string; warning_code: "latch_resident_user" }
      • 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: "latch_resident_user"
    workspace_id: string

    ID of the workspace that contains the access system user.

    Settings
    Member Visibility

    On This Page
    Properties