Class SeamHttpAcsSystems

constructor

• new SeamHttpAcsSystems(apiKeyOrOptions?): SeamHttpAcsSystems

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsSystems

client

Readonlydefaults

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_system: {
          acs_system_id: string;
          can_add_acs_users_to_acs_access_groups?: boolean;
          can_automate_enrollment?: boolean;
          can_create_acs_access_groups?: boolean;
          can_remove_acs_users_from_acs_access_groups?: boolean;
          connected_account_id: string;
          connected_account_ids: string[];
          created_at: string;
          default_credential_manager_acs_system_id?: null | string;
          errors: (
              | {
                  created_at: string;
                  error_code: "seam_bridge_disconnected";
                  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;
              })[];
          external_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          is_credential_manager: boolean;
          location: {
              time_zone: null | string;
          };
          name: string;
          system_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          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";
          })[];
          workspace_id: string;
      };
  }>, "acs_system">, "acs_system">

• Parameters

  • Optionalbody: {
        acs_system_id: string;
    }

    • acs_system_id: string

      ID of the desired access control system.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_system: {
          acs_system_id: string;
          can_add_acs_users_to_acs_access_groups?: boolean;
          can_automate_enrollment?: boolean;
          can_create_acs_access_groups?: boolean;
          can_remove_acs_users_from_acs_access_groups?: boolean;
          connected_account_id: string;
          connected_account_ids: string[];
          created_at: string;
          default_credential_manager_acs_system_id?: null | string;
          errors: (
              | {
                  created_at: string;
                  error_code: "seam_bridge_disconnected";
                  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;
              })[];
          external_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          is_credential_manager: boolean;
          location: {
              time_zone: null | string;
          };
          name: string;
          system_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          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";
          })[];
          workspace_id: string;
      };
  }>, "acs_system">, "acs_system">

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_systems: {
          acs_system_id: string;
          can_add_acs_users_to_acs_access_groups?: boolean;
          can_automate_enrollment?: boolean;
          can_create_acs_access_groups?: boolean;
          can_remove_acs_users_from_acs_access_groups?: boolean;
          connected_account_id: string;
          connected_account_ids: string[];
          created_at: string;
          default_credential_manager_acs_system_id?: null | string;
          errors: (
              | {
                  created_at: string;
                  error_code: "seam_bridge_disconnected";
                  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;
              })[];
          external_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          is_credential_manager: boolean;
          location: {
              time_zone: null | string;
          };
          name: string;
          system_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          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?: (...)[];
              warning_code: "time_zone_does_not_match_location";
          })[];
          workspace_id: string;
      }[];
  }>, "acs_systems">, "acs_systems">

• Parameters

  • Optionalbody: {
        connected_account_id?: string;
    }

    • Optionalconnected_account_id?: string

      ID of the connected account by which to filter the list of returned access control systems.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_systems: {
          acs_system_id: string;
          can_add_acs_users_to_acs_access_groups?: boolean;
          can_automate_enrollment?: boolean;
          can_create_acs_access_groups?: boolean;
          can_remove_acs_users_from_acs_access_groups?: boolean;
          connected_account_id: string;
          connected_account_ids: string[];
          created_at: string;
          default_credential_manager_acs_system_id?: null | string;
          errors: (
              | {
                  created_at: string;
                  error_code: "seam_bridge_disconnected";
                  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;
              })[];
          external_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          is_credential_manager: boolean;
          location: {
              time_zone: null | string;
          };
          name: string;
          system_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          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?: (...)[];
              warning_code: "time_zone_does_not_match_location";
          })[];
          workspace_id: string;
      }[];
  }>, "acs_systems">, "acs_systems">

listCompatibleCredentialManagerAcsSystems

• listCompatibleCredentialManagerAcsSystems(body?): SeamHttpRequest<SetNonNullable<Required<{
      acs_systems: {
          acs_system_id: string;
          can_add_acs_users_to_acs_access_groups?: boolean;
          can_automate_enrollment?: boolean;
          can_create_acs_access_groups?: boolean;
          can_remove_acs_users_from_acs_access_groups?: boolean;
          connected_account_id: string;
          connected_account_ids: string[];
          created_at: string;
          default_credential_manager_acs_system_id?: null | string;
          errors: (
              | {
                  created_at: string;
                  error_code: "seam_bridge_disconnected";
                  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;
              })[];
          external_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          is_credential_manager: boolean;
          location: {
              time_zone: null | string;
          };
          name: string;
          system_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          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?: (...)[];
              warning_code: "time_zone_does_not_match_location";
          })[];
          workspace_id: string;
      }[];
  }>, "acs_systems">, "acs_systems">

• Parameters

  • Optionalbody: {
        acs_system_id: string;
    }

    • acs_system_id: string

      ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      acs_systems: {
          acs_system_id: string;
          can_add_acs_users_to_acs_access_groups?: boolean;
          can_automate_enrollment?: boolean;
          can_create_acs_access_groups?: boolean;
          can_remove_acs_users_from_acs_access_groups?: boolean;
          connected_account_id: string;
          connected_account_ids: string[];
          created_at: string;
          default_credential_manager_acs_system_id?: null | string;
          errors: (
              | {
                  created_at: string;
                  error_code: "seam_bridge_disconnected";
                  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;
              })[];
          external_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          external_type_display_name?: string;
          image_alt_text: string;
          image_url: string;
          is_credential_manager: boolean;
          location: {
              time_zone: null | string;
          };
          name: string;
          system_type?:
              | "pti_site"
              | "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"
              | "legic_connect_credential_service"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service";
          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?: (...)[];
              warning_code: "time_zone_does_not_match_location";
          })[];
          workspace_id: string;
      }[];
  }>, "acs_systems">, "acs_systems">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsSystems

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpAcsSystems

StaticfromClient

• fromClient(client, options?): SeamHttpAcsSystems

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpAcsSystems

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsSystems

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpAcsSystems

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAcsSystems

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpAcsSystems

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAcsSystems

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpAcsSystems

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpAcsSystems>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAcsSystems>