Class SeamHttpAcsEncoders

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsEncoders

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

simulate

• get simulate(): SeamHttpAcsEncodersSimulate

  Returns SeamHttpAcsEncodersSimulate

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>

encodeCredential

• encodeCredential(
      parameters?: {
          access_method_id?: string;
          acs_credential_id?: string;
          acs_encoder_id: string;
      },
      options?: AcsEncodersEncodeCredentialOptions,
  ): AcsEncodersEncodeCredentialRequest

  Parameters

  • Optionalparameters: {
        access_method_id?: string;
        acs_credential_id?: string;
        acs_encoder_id: string;
    }

    • Optionalaccess_method_id?: string

      ID of the access_method to encode onto a card.

    • Optionalacs_credential_id?: string

      ID of the acs_credential to encode onto a card.

    • acs_encoder_id: string

      ID of the acs_encoder to use to encode the acs_credential.

  • options: AcsEncodersEncodeCredentialOptions = {}

  Returns AcsEncodersEncodeCredentialRequest

get

• get(
      parameters?: { acs_encoder_id: string },
      options?: AcsEncodersGetOptions,
  ): AcsEncodersGetRequest

  Parameters

  • Optionalparameters: { acs_encoder_id: string }

    • acs_encoder_id: string

      ID of the encoder that you want to get.

  • options: AcsEncodersGetOptions = {}

  Returns AcsEncodersGetRequest

list

• list(
      parameters?: AcsEncodersListParameters,
      options?: AcsEncodersListOptions,
  ): AcsEncodersListRequest

  Parameters

  • Optionalparameters: AcsEncodersListParameters
  • options: AcsEncodersListOptions = {}

  Returns AcsEncodersListRequest

scanCredential

• scanCredential(
      parameters?: {
          acs_encoder_id: string;
          salto_ks_metadata?: { detect_new_tags?: boolean };
      },
      options?: AcsEncodersScanCredentialOptions,
  ): AcsEncodersScanCredentialRequest

  Parameters

  • Optionalparameters: { acs_encoder_id: string; salto_ks_metadata?: { detect_new_tags?: boolean } }

    • acs_encoder_id: string

      ID of the encoder to use for the scan.

    • Optionalsalto_ks_metadata?: { detect_new_tags?: boolean }

      Salto KS-specific metadata for the scan action.

      • Optionaldetect_new_tags?: boolean

        When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.

  • options: AcsEncodersScanCredentialOptions = {}

  Returns AcsEncodersScanCredentialRequest

scanToAssignCredential

• scanToAssignCredential(
      parameters?: {
          acs_encoder_id: string;
          acs_user_id?: string;
          salto_ks_metadata?: { detect_new_tags?: boolean };
          user_identity_id?: string;
      },
      options?: AcsEncodersScanToAssignCredentialOptions,
  ): AcsEncodersScanToAssignCredentialRequest

  Parameters

  • Optionalparameters: {
        acs_encoder_id: string;
        acs_user_id?: string;
        salto_ks_metadata?: { detect_new_tags?: boolean };
        user_identity_id?: string;
    }

    • acs_encoder_id: string

      ID of the acs_encoder to use to scan the credential.

    • Optionalacs_user_id?: string

      ID of the acs_user to assign the scanned credential to.

    • Optionalsalto_ks_metadata?: { detect_new_tags?: boolean }

      Salto KS-specific metadata for the scan action.

      • Optionaldetect_new_tags?: boolean

        When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.

    • Optionaluser_identity_id?: string

      ID of the user_identity to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.

  • options: AcsEncodersScanToAssignCredentialOptions = {}

  Returns AcsEncodersScanToAssignCredentialRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAcsEncoders

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAcsEncoders

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAcsEncoders

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAcsEncoders

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAcsEncoders

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAcsEncoders>