Class TotpSecret

constructor

• new TotpSecret(secretKey: string, auth: AuthInternal): TotpSecret

  Parameters

  • secretKey: string
  • auth: AuthInternal

  Returns TotpSecret

generateQrCodeUrl

• generateQrCodeUrl(accountName?: string, issuer?: string): string

  Returns a QR code URL as described in https://github.com/google/google-authenticator/wiki/Key-Uri-Format This can be displayed to the user as a QR code to be scanned into a TOTP app like Google Authenticator. If the optional parameters are unspecified, an accountName of and issuer of are used.

  Parameters

  • OptionalaccountName: string

    the name of the account/app along with a user identifier.

  • Optionalissuer: string

    issuer of the TOTP (likely the app name).

  Returns string

  A QR code URL string.

openInOtpApp

• openInOtpApp(qrCodeUrl: string): string | void

  Opens the specified QR Code URL in an OTP authenticator app on the device. The shared secret key and account name will be populated in the OTP authenticator app. The URL uses the otpauth:// scheme and will be opened on an app that handles this scheme, if it exists on the device, possibly opening the ecocystem-specific app store with a generic query for compatible apps if no app exists on the device.

  Parameters

  • qrCodeUrl: string

    the URL to open in the app, from generateQrCodeUrl

  Returns string | void

ReadonlysecretKey