Type Alias AcsSystem

Within an acs_system, create acs_users and acs_credentials to grant access to the acs_users.

For details about the resources associated with an access control system, see the access control systems namespace.

type AcsSystem = {
    acs_access_group_count?: number;
    acs_system_id: string;
    acs_user_count?: number;
    connected_account_id: string;
    connected_account_ids: string[];
    created_at: string;
    default_credential_manager_acs_system_id?: string | null;
    errors: (
        | {
            created_at: string;
            error_code: "seam_bridge_disconnected";
            message: string;
        }
        | {
            created_at: string;
            error_code: "bridge_disconnected";
            is_bridge_error?: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "visionline_instance_unreachable";
            message: string;
        }
        | {
            created_at: string;
            error_code: "salto_ks_subscription_limit_exceeded";
            message: string;
        }
        | {
            created_at: string;
            error_code: "acs_system_disconnected";
            message: string;
        }
        | {
            created_at: string;
            error_code: "account_disconnected";
            message: string;
        }
        | {
            created_at: string;
            error_code: "salto_ks_certification_expired";
            message: string;
        }
        | {
            created_at: string;
            error_code: "provider_service_unavailable";
            message: string;
        }
    )[];
    external_type?: | "pti_site"
    | "avigilon_alta_org"
    | "salto_ks_site"
    | "salto_space_system"
    | "brivo_account"
    | "hid_credential_manager_organization"
    | "visionline_system"
    | "assa_abloy_credential_service"
    | "latch_building"
    | "dormakaba_community_site"
    | "dormakaba_ambiance_site"
    | "legic_connect_credential_service"
    | "assa_abloy_vostio"
    | "assa_abloy_vostio_credential_service"
    | "hotek_site"
    | "kisi_organization"
    | "akiles_organization";
    external_type_display_name?: string;
    image_alt_text: string;
    image_url: string;
    is_credential_manager: boolean;
    location: { time_zone: string
    | null };
    name: string;
    system_type?:
        | "pti_site"
        | "avigilon_alta_org"
        | "salto_ks_site"
        | "salto_space_system"
        | "brivo_account"
        | "hid_credential_manager_organization"
        | "visionline_system"
        | "assa_abloy_credential_service"
        | "latch_building"
        | "dormakaba_community_site"
        | "dormakaba_ambiance_site"
        | "legic_connect_credential_service"
        | "assa_abloy_vostio"
        | "assa_abloy_vostio_credential_service"
        | "hotek_site"
        | "kisi_organization"
        | "akiles_organization";
    system_type_display_name?: string;
    visionline_metadata?: {
        lan_address?: string;
        mobile_access_uuid?: string;
        system_id?: string;
    };
    warnings: (
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_subscription_limit_almost_reached";
        }
        | {
            created_at: string;
            message: string;
            misconfigured_acs_entrance_ids?: string[];
            warning_code: "time_zone_does_not_match_location";
        }
        | { created_at: string; message: string; warning_code: "setup_required" }
    )[];
    workspace_id: string;
}

Properties

`Optional`acs_access_group_count

acs_access_group_count?: number

Number of access groups in the access control system.

acs_system_id

acs_system_id: string

ID of the access control system.

`Optional`acs_user_count

acs_user_count?: number

Number of users in the access control system.

connected_account_id

connected_account_id: string

ID of the connected account associated with the access control system.

connected_account_ids

connected_account_ids: string[]

IDs of the connected accounts associated with the access control system.

Deprecated

Use connected_account_id.

created_at

created_at: string

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

`Optional`default_credential_manager_acs_system_id

default_credential_manager_acs_system_id?: string | null

ID of the default credential manager acs_system for this access control system.

errors

errors: (
    | {
        created_at: string;
        error_code: "seam_bridge_disconnected";
        message: string;
    }
    | {
        created_at: string;
        error_code: "bridge_disconnected";
        is_bridge_error?: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "visionline_instance_unreachable";
        message: string;
    }
    | {
        created_at: string;
        error_code: "salto_ks_subscription_limit_exceeded";
        message: string;
    }
    | {
        created_at: string;
        error_code: "acs_system_disconnected";
        message: string;
    }
    | {
        created_at: string;
        error_code: "account_disconnected";
        message: string;
    }
    | {
        created_at: string;
        error_code: "salto_ks_certification_expired";
        message: string;
    }
    | {
        created_at: string;
        error_code: "provider_service_unavailable";
        message: string;
    }
)[]

Errors associated with the access control system.

Type Declaration

{ created_at: string; error_code: "seam_bridge_disconnected"; message: string }
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "seam_bridge_disconnected"
  
  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.
{
    created_at: string;
    error_code: "bridge_disconnected";
    is_bridge_error?: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "bridge_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- Optionalis_bridge_error?: boolean
  
  Indicates whether the error is related to the Seam Bridge.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "visionline_instance_unreachable";
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "visionline_instance_unreachable"
  
  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.
{
    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"
  
  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.
{ created_at: string; error_code: "acs_system_disconnected"; message: string }
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "acs_system_disconnected"
  
  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.
{ created_at: string; error_code: "account_disconnected"; message: string }
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "account_disconnected"
  
  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.
{
    created_at: string;
    error_code: "salto_ks_certification_expired";
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "salto_ks_certification_expired"
  
  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.
{
    created_at: string;
    error_code: "provider_service_unavailable";
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "provider_service_unavailable"
  
  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.

`Optional`external_type

Brand-specific terminology for the access control system type.

`Optional`external_type_display_name

external_type_display_name?: string

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

image_alt_text

image_alt_text: string

Alternative text for the access control system image.

image_url

image_url: string

URL for the image that represents the access control system.

is_credential_manager

is_credential_manager: boolean

Indicates whether the acs_system is a credential manager.

location

location: { time_zone: string | null }

Location information for the access control system.

Type Declaration

time_zone: string | null

Time zone in which the access control system is located.

name

name: string

Name of the access control system.

`Optional`system_type

Deprecated

Use external_type.

`Optional`system_type_display_name

system_type_display_name?: string

Deprecated

Use external_type_display_name.

`Optional`visionline_metadata

visionline_metadata?: {
    lan_address?: string;
    mobile_access_uuid?: string;
    system_id?: string;
}

Visionline-specific metadata for the access control system.

Type Declaration

Optionallan_address?: string

IP address or hostname of the main Visionline server relative to Seam Bridge on the local network.
Optionalmobile_access_uuid?: string

Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
Optionalsystem_id?: string

Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.

warnings

warnings: (
    | {
        created_at: string;
        message: string;
        warning_code: "salto_ks_subscription_limit_almost_reached";
    }
    | {
        created_at: string;
        message: string;
        misconfigured_acs_entrance_ids?: string[];
        warning_code: "time_zone_does_not_match_location";
    }
    | { created_at: string; message: string; warning_code: "setup_required" }
)[]

Warnings associated with the access control system.

Type Declaration

{
    created_at: string;
    message: string;
    warning_code: "salto_ks_subscription_limit_almost_reached";
}
- 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_subscription_limit_almost_reached"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    misconfigured_acs_entrance_ids?: string[];
    warning_code: "time_zone_does_not_match_location";
}
- 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.
- Optionalmisconfigured_acs_entrance_ids?: string[]
  
  Deprecated
  this field is deprecated.
- warning_code: "time_zone_does_not_match_location"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "setup_required" }
- 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: "setup_required"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

workspace_id

workspace_id: string

ID of the workspace that contains the access control system.

Type Alias AcsSystem

Index

Properties

Properties

Optionalacs_access_group_count

acs_system_id

Optionalacs_user_count

connected_account_id

connected_account_ids

Deprecated

created_at

Optionaldefault_credential_manager_acs_system_id

errors

Type Declaration

created_at: string

error_code: "seam_bridge_disconnected"

message: string

created_at: string

error_code: "bridge_disconnected"

Optionalis_bridge_error?: boolean

message: string

created_at: string

error_code: "visionline_instance_unreachable"

message: string

created_at: string

error_code: "salto_ks_subscription_limit_exceeded"

message: string

created_at: string

error_code: "acs_system_disconnected"

message: string

created_at: string

error_code: "account_disconnected"

message: string

created_at: string

error_code: "salto_ks_certification_expired"

message: string

created_at: string

error_code: "provider_service_unavailable"

message: string

Optionalexternal_type

Optionalexternal_type_display_name

image_alt_text

image_url

is_credential_manager

location

Type Declaration

time_zone: string | null

name

Optionalsystem_type

Deprecated

Optionalsystem_type_display_name

Deprecated

Optionalvisionline_metadata

Type Declaration

Optionallan_address?: string

Optionalmobile_access_uuid?: string

Optionalsystem_id?: string

warnings

Type Declaration

created_at: string

message: string

warning_code: "salto_ks_subscription_limit_almost_reached"

created_at: string

message: string

Optionalmisconfigured_acs_entrance_ids?: string[]

Deprecated

warning_code: "time_zone_does_not_match_location"

created_at: string

message: string

warning_code: "setup_required"

workspace_id

Settings

On This Page

`Optional`acs_access_group_count

`Optional`acs_user_count

`Optional`default_credential_manager_acs_system_id

`Optional`is_bridge_error?: boolean

`Optional`external_type

`Optional`external_type_display_name

`Optional`system_type

`Optional`system_type_display_name

`Optional`visionline_metadata

`Optional`lan_address?: string

`Optional`mobile_access_uuid?: string

`Optional`system_id?: string

`Optional`misconfigured_acs_entrance_ids?: string[]