Class SeamHttpAcsCredentials

constructor

• new SeamHttpAcsCredentials(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpAcsCredentials

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsCredentials

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

unmanaged

• get unmanaged(): SeamHttpAcsCredentialsUnmanaged

  Returns SeamHttpAcsCredentialsUnmanaged

assign

• assign(
      parameters: {
          acs_credential_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsCredentialsAssignOptions,
  ): AcsCredentialsAssignRequest

  Parameters

  • parameters: { acs_credential_id: string; acs_user_id?: string; user_identity_id?: string }

    • acs_credential_id: string

      ID of the credential that you want to assign to an access system user.

    • Optionalacs_user_id?: string

      ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same email_address or phone_number as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.

  • options: AcsCredentialsAssignOptions = {}

  Returns AcsCredentialsAssignRequest

create

• create(
      parameters: {
          access_method: "code" | "card" | "mobile_key" | "cloud_key";
          acs_system_id?: string;
          acs_user_id?: string;
          allowed_acs_entrance_ids?: string[];
          assa_abloy_vostio_metadata?: {
              auto_join?: boolean;
              join_all_guest_acs_entrances?: boolean;
              override_all_guest_acs_entrances?: boolean;
              override_guest_acs_entrance_ids?: string[];
          };
          code?: string;
          credential_manager_acs_system_id?: string;
          ends_at?: string;
          hotek_metadata?: { auto_join?: boolean; override?: boolean };
          is_multi_phone_sync_credential?: boolean;
          salto_space_metadata?: {
              assign_new_key?: boolean;
              update_current_key?: boolean;
          };
          starts_at?: string;
          user_identity_id?: string;
          visionline_metadata?: {
              assa_abloy_credential_service_mobile_endpoint_id?: string;
              auto_join?: boolean;
              card_format?: "TLCode"
              | "rfid48";
              card_function_type?: "guest" | "staff";
              is_override_key?: boolean;
              joiner_acs_credential_ids?: string[];
              override?: boolean;
          };
      },
      options?: AcsCredentialsCreateOptions,
  ): AcsCredentialsCreateRequest

  Parameters

  • parameters: {
        access_method: "code" | "card" | "mobile_key" | "cloud_key";
        acs_system_id?: string;
        acs_user_id?: string;
        allowed_acs_entrance_ids?: string[];
        assa_abloy_vostio_metadata?: {
            auto_join?: boolean;
            join_all_guest_acs_entrances?: boolean;
            override_all_guest_acs_entrances?: boolean;
            override_guest_acs_entrance_ids?: string[];
        };
        code?: string;
        credential_manager_acs_system_id?: string;
        ends_at?: string;
        hotek_metadata?: { auto_join?: boolean; override?: boolean };
        is_multi_phone_sync_credential?: boolean;
        salto_space_metadata?: {
            assign_new_key?: boolean;
            update_current_key?: boolean;
        };
        starts_at?: string;
        user_identity_id?: string;
        visionline_metadata?: {
            assa_abloy_credential_service_mobile_endpoint_id?: string;
            auto_join?: boolean;
            card_format?: "TLCode"
            | "rfid48";
            card_function_type?: "guest" | "staff";
            is_override_key?: boolean;
            joiner_acs_credential_ids?: string[];
            override?: boolean;
        };
    }

    • access_method: "code" | "card" | "mobile_key" | "cloud_key"

      Access method for the new credential. Supported values: code, card, mobile_key, cloud_key.

    • Optionalacs_system_id?: string

      ID of the access system to which the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

    • Optionalacs_user_id?: string

      ID of the access system user to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

    • Optionalallowed_acs_entrance_ids?: string[]

      Set of IDs of the entrances for which the new credential grants access.

    • Optionalassa_abloy_vostio_metadata?: {
          auto_join?: boolean;
          join_all_guest_acs_entrances?: boolean;
          override_all_guest_acs_entrances?: boolean;
          override_guest_acs_entrance_ids?: string[];
      }

      Vostio-specific metadata for the new credential.

    • Optionalcode?: string

      Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide.

    • Optionalcredential_manager_acs_system_id?: string

      ACS system ID of the credential manager for the new credential.

    • Optionalends_at?: string

      Date and time at which the validity of the new credential ends, in ISO 8601 format. Must be a time in the future and after starts_at.

    • Optionalhotek_metadata?: { auto_join?: boolean; override?: boolean }

    • Optionalis_multi_phone_sync_credential?: boolean

      Indicates whether the new credential is a multi-phone sync credential.

    • Optionalsalto_space_metadata?: { assign_new_key?: boolean; update_current_key?: boolean }

      Salto Space-specific metadata for the new credential.

      • Optionalassign_new_key?: boolean

        Indicates whether to assign a first, new card to a user. See also Programming Salto Space Card-based Credentials.

      • Optionalupdate_current_key?: boolean

        Indicates whether to update the user's existing card. See also Programming Salto Space Card-based Credentials.

    • Optionalstarts_at?: string

      Date and time at which the validity of the new credential starts, in ISO 8601 format.

    • Optionaluser_identity_id?: string

      ID of the user identity to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id. If the access system contains a user with the same email_address or phone_number as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.

    • Optionalvisionline_metadata?: {
          assa_abloy_credential_service_mobile_endpoint_id?: string;
          auto_join?: boolean;
          card_format?: "TLCode" | "rfid48";
          card_function_type?: "guest" | "staff";
          is_override_key?: boolean;
          joiner_acs_credential_ids?: string[];
          override?: boolean;
      }

      Visionline-specific metadata for the new credential.

      • Optionalassa_abloy_credential_service_mobile_endpoint_id?: string

        Deprecated

        Read-only endpoint references moved to endpoint.

      • Optionalauto_join?: boolean

      • Optionalcard_format?: "TLCode" | "rfid48"

      • Optionalcard_function_type?: "guest" | "staff"

      • Optionalis_override_key?: boolean

        Deprecated

        Use override instead.

      • Optionaljoiner_acs_credential_ids?: string[]

      • Optionaloverride?: boolean

  • options: AcsCredentialsCreateOptions = {}

  Returns AcsCredentialsCreateRequest

createOfflineCode

• createOfflineCode(
      parameters: {
          acs_user_id: string;
          allowed_acs_entrance_id: string;
          ends_at?: string;
          is_one_time_use?: boolean;
          starts_at?: string;
      },
      options?: AcsCredentialsCreateOfflineCodeOptions,
  ): AcsCredentialsCreateOfflineCodeRequest

  Parameters

  • parameters: {
        acs_user_id: string;
        allowed_acs_entrance_id: string;
        ends_at?: string;
        is_one_time_use?: boolean;
        starts_at?: string;
    }

    • acs_user_id: string

      ID of the access system user to whom the new credential belongs.

    • allowed_acs_entrance_id: string

      IDs of the acs_entrances for which the new credential grants access.

    • Optionalends_at?: string

      Date and time at which the validity of the new credential ends, in ISO 8601 format. Must be a time in the future and after starts_at.

    • Optionalis_one_time_use?: boolean

      Indicates whether the code is one-time-use or reusable.

    • Optionalstarts_at?: string

      Date and time at which the validity of the new credential starts, in ISO 8601 format.

  • options: AcsCredentialsCreateOfflineCodeOptions = {}

  Returns AcsCredentialsCreateOfflineCodeRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters: { acs_credential_id: string },
      options?: AcsCredentialsDeleteOptions,
  ): AcsCredentialsDeleteRequest

  Parameters

  • parameters: { acs_credential_id: string }

    • acs_credential_id: string

      ID of the credential that you want to delete.

  • options: AcsCredentialsDeleteOptions = {}

  Returns AcsCredentialsDeleteRequest

get

• get(
      parameters: { acs_credential_id: string },
      options?: AcsCredentialsGetOptions,
  ): AcsCredentialsGetRequest

  Parameters

  • parameters: { acs_credential_id: string }

    • acs_credential_id: string

      ID of the credential that you want to get.

  • options: AcsCredentialsGetOptions = {}

  Returns AcsCredentialsGetRequest

list

• list(
      parameters?: AcsCredentialsListParameters,
      options?: AcsCredentialsListOptions,
  ): AcsCredentialsListRequest

  Parameters

  • Optionalparameters: AcsCredentialsListParameters
  • options: AcsCredentialsListOptions = {}

  Returns AcsCredentialsListRequest

listAccessibleEntrances

• listAccessibleEntrances(
      parameters: { acs_credential_id: string },
      options?: AcsCredentialsListAccessibleEntrancesOptions,
  ): AcsCredentialsListAccessibleEntrancesRequest

  Parameters

  • parameters: { acs_credential_id: string }

    • acs_credential_id: string

      ID of the credential for which you want to retrieve all entrances to which the credential grants access.

  • options: AcsCredentialsListAccessibleEntrancesOptions = {}

  Returns AcsCredentialsListAccessibleEntrancesRequest

unassign

• unassign(
      parameters: {
          acs_credential_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsCredentialsUnassignOptions,
  ): AcsCredentialsUnassignRequest

  Parameters

  • parameters: { acs_credential_id: string; acs_user_id?: string; user_identity_id?: string }

    • acs_credential_id: string

      ID of the credential that you want to unassign from an access system user.

    • Optionalacs_user_id?: string

      ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.

    • Optionaluser_identity_id?: string

      ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.

  • options: AcsCredentialsUnassignOptions = {}

  Returns AcsCredentialsUnassignRequest

update

• update(
      parameters: {
          acs_credential_id: string;
          code?: string;
          ends_at?: string;
      },
      options?: AcsCredentialsUpdateOptions,
  ): AcsCredentialsUpdateRequest

  Parameters

  • parameters: { acs_credential_id: string; code?: string; ends_at?: string }

    • acs_credential_id: string

      ID of the credential that you want to update.

    • Optionalcode?: string

      Replacement access (PIN) code for the credential that you want to update.

    • Optionalends_at?: string

      Replacement date and time at which the validity of the credential ends, in ISO 8601 format. Must be a time in the future and after the starts_at value that you set when creating the credential.

  • options: AcsCredentialsUpdateOptions = {}

  Returns AcsCredentialsUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpAcsCredentials

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpAcsCredentials

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpAcsCredentials

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpAcsCredentials

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpAcsCredentials

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpAcsCredentials>

  Parameters

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

  Returns Promise<SeamHttpAcsCredentials>