Class SeamHttpAcsEntrances

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsEntrances

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

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>

get

• get(
      parameters?: { acs_entrance_id: string },
      options?: AcsEntrancesGetOptions,
  ): AcsEntrancesGetRequest

  Parameters

  • Optionalparameters: { acs_entrance_id: string }

    • acs_entrance_id: string

      ID of the entrance that you want to get.
  • options: AcsEntrancesGetOptions = {}

  Returns AcsEntrancesGetRequest

grantAccess

• grantAccess(
      parameters?: {
          acs_entrance_id: string;
          acs_user_id?: string;
          user_identity_id?: string;
      },
      options?: AcsEntrancesGrantAccessOptions,
  ): AcsEntrancesGrantAccessRequest

  Parameters

  • Optionalparameters: { acs_entrance_id: string; acs_user_id?: string; user_identity_id?: string }

    • acs_entrance_id: string

      ID of the entrance to which you want to grant an access system user access.

    • Optionalacs_user_id?: string

      ID of the access system user to whom you want to grant access to an entrance. 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 grant access to an entrance. 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 access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
  • options: AcsEntrancesGrantAccessOptions = {}

  Returns AcsEntrancesGrantAccessRequest

list

• list(
      parameters?: {
          acs_credential_id?: string;
          acs_entrance_ids?: string[];
          acs_system_id?: string;
          connected_account_id?: string;
          customer_key?: string;
          limit?: number;
          location_id?: null | string;
          page_cursor?: null | string;
          search?: string;
          space_id?: string;
      },
      options?: AcsEntrancesListOptions,
  ): AcsEntrancesListRequest

  Parameters

  • Optionalparameters: {
        acs_credential_id?: string;
        acs_entrance_ids?: string[];
        acs_system_id?: string;
        connected_account_id?: string;
        customer_key?: string;
        limit?: number;
        location_id?: null | string;
        page_cursor?: null | string;
        search?: string;
        space_id?: string;
    }

    • Optionalacs_credential_id?: string

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

    • Optionalacs_entrance_ids?: string[]

      IDs of the entrances for which you want to retrieve all entrances.

    • Optionalacs_system_id?: string

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

    • Optionalconnected_account_id?: string

      ID of the connected account for which you want to retrieve all entrances.

    • Optionalcustomer_key?: string

      Customer key for which you want to list entrances.

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionallocation_id?: null | string

      Deprecated

      Use space_id.

    • Optionalpage_cursor?: null | string

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalsearch?: string

      String for which to search. Filters returned entrances to include all records that satisfy a partial match using display_name.

    • Optionalspace_id?: string

      ID of the space for which you want to list entrances.
  • options: AcsEntrancesListOptions = {}

  Returns AcsEntrancesListRequest

listCredentialsWithAccess

• listCredentialsWithAccess(
      parameters?: {
          acs_entrance_id: string;
          include_if?: "visionline_metadata.is_valid"[];
      },
      options?: AcsEntrancesListCredentialsWithAccessOptions,
  ): AcsEntrancesListCredentialsWithAccessRequest

  Parameters

  • Optionalparameters: { acs_entrance_id: string; include_if?: "visionline_metadata.is_valid"[] }

    • acs_entrance_id: string

      ID of the entrance for which you want to list all credentials that grant access.

    • Optionalinclude_if?: "visionline_metadata.is_valid"[]

      Conditions that credentials must meet to be included in the returned list.
  • options: AcsEntrancesListCredentialsWithAccessOptions = {}

  Returns AcsEntrancesListCredentialsWithAccessRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAcsEntrances

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAcsEntrances>