auth.totpsecret.md

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

TotpSecret class

Provider for generating a TotpMultiFactorAssertion.

Stores the shared secret key and other parameters to generate time-based OTPs. Implements methods to retrieve the shared secret key and generate a QR code URL.

Signature:

exportdeclareclassTotpSecret

Properties

Property	Modifiers	Type	Description
codeIntervalSeconds		number	The interval (in seconds) when the OTP codes should change.
codeLength		number	Length of the one-time passwords to be generated.
enrollmentCompletionDeadline		string	The timestamp (UTC string) by which TOTP enrollment should be completed.
hashingAlgorithm		string	Hashing algorithm used.
secretKey		string	Shared secret key/seed used for enrolling in TOTP MFA and generating OTPs.

Methods

Method	Modifiers	Description
generateQrCodeUrl(accountName, issuer)		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.

TotpSecret.codeIntervalSeconds

The interval (in seconds) when the OTP codes should change.

Signature:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

Length of the one-time passwords to be generated.

Signature:

readonly codeLength: number;

TotpSecret.enrollmentCompletionDeadline

The timestamp (UTC string) by which TOTP enrollment should be completed.

Signature:

readonly enrollmentCompletionDeadline: string;

TotpSecret.hashingAlgorithm

Hashing algorithm used.

Signature:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

Shared secret key/seed used for enrolling in TOTP MFA and generating OTPs.

Signature:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

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.

Signature:

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

Parameters

Parameter	Type	Description
accountName	string	the name of the account/app along with a user identifier.
issuer	string	issuer of the TOTP (likely the app name).

Returns:

string

A QR code URL string.