TotpSecret
A TOTP secret to enroll an authenticator app with, mirroring com.google.firebase.auth.TotpSecret.
The iOS SDK exposes only the shared secret, the QR code URL and the OTP app hand-off: on Apple platforms the hash algorithm and the code length are read from the QR code URL, and codeIntervalSeconds, enrollmentCompletionDeadline and sessionInfo throw UnsupportedOperationException. The JS SDK keeps the session private, so sessionInfo throws there too.
The iOS SDK's FIRTOTPSecret exposes the shared secret, the QR code URL and the OTP app hand-off only: the hash algorithm and the code length are read from the QR code URL, and the other parameters throw. The iOS SDK provides TOTP on iOS only; on tvOS no secret can be generated.
A TOTP secret to enroll an authenticator app with, mirroring com.google.firebase.auth.TotpSecret.
The iOS SDK exposes only the shared secret, the QR code URL and the OTP app hand-off: on Apple platforms the hash algorithm and the code length are read from the QR code URL, and codeIntervalSeconds, enrollmentCompletionDeadline and sessionInfo throw UnsupportedOperationException. The JS SDK keeps the session private, so sessionInfo throws there too.
The JS SDK's TotpSecret has every parameter but the session, which it keeps private.
The JS SDK's TotpSecret has every parameter but the session, which it keeps private.
Properties
How often the one-time passwords change, in seconds. Throws UnsupportedOperationException on Apple platforms.
Throws UnsupportedOperationException: the iOS SDK does not expose the interval.
How often the one-time passwords change, in seconds. Throws UnsupportedOperationException on Apple platforms.
How often the one-time passwords change, in seconds. Throws UnsupportedOperationException on Apple platforms.
How often the one-time passwords change, in seconds. Throws UnsupportedOperationException on Apple platforms.
The number of digits of the one-time passwords.
The digits of the QR code URL, where the iOS SDK exposes it.
The number of digits of the one-time passwords.
The number of digits of the one-time passwords.
The number of digits of the one-time passwords.
When the enrollment has to be completed by, in seconds since the epoch. Throws UnsupportedOperationException on Apple platforms.
Throws UnsupportedOperationException: the iOS SDK does not expose the deadline.
When the enrollment has to be completed by, in seconds since the epoch. Throws UnsupportedOperationException on Apple platforms.
When the enrollment has to be completed by, in seconds since the epoch. Throws UnsupportedOperationException on Apple platforms.
When the enrollment has to be completed by, in seconds since the epoch. Throws UnsupportedOperationException on Apple platforms.
The hash algorithm of the one-time passwords, such as SHA1.
The algorithm of the QR code URL, where the iOS SDK exposes it.
The hash algorithm of the one-time passwords, such as SHA1.
The hash algorithm of the one-time passwords, such as SHA1.
The hash algorithm of the one-time passwords, such as SHA1.
The session of the enrollment, which the SDK sends back with the one-time password. Android only: throws UnsupportedOperationException on Apple platforms, JS and Wasm, whose SDKs keep it private.
Throws UnsupportedOperationException: the iOS SDK keeps the session private.
The session of the enrollment, which the SDK sends back with the one-time password. Android only: throws UnsupportedOperationException on Apple platforms, JS and Wasm, whose SDKs keep it private.
Throws UnsupportedOperationException: the JS SDK keeps the session private.
Throws UnsupportedOperationException: the JS SDK keeps the session private.
The shared secret, to enter in the authenticator app by hand.
The shared secret, to enter in the authenticator app by hand.
The shared secret, to enter in the authenticator app by hand.
The shared secret, to enter in the authenticator app by hand.
The shared secret, to enter in the authenticator app by hand.
Functions
A URL of a QR code the authenticator app can scan, for the signed-in user's email at the app's name, as generateQrCodeUrl(email, app.name). It fails without a signed-in user with an email, except on JS and Wasm, where the JS SDK names the account unknownuser then.
A URL of a QR code the authenticator app can scan, for accountName at issuer.
A URL of a QR code the authenticator app can scan, for the signed-in user's email at the app's name, as generateQrCodeUrl(email, app.name). It fails without a signed-in user with an email, except on JS and Wasm, where the JS SDK names the account unknownuser then.
A URL of a QR code the authenticator app can scan, for accountName at issuer.
A URL of a QR code the authenticator app can scan, for the signed-in user's email at the app's name, as generateQrCodeUrl(email, app.name). It fails without a signed-in user with an email, except on JS and Wasm, where the JS SDK names the account unknownuser then.
A URL of a QR code the authenticator app can scan, for accountName at issuer.
A URL of a QR code the authenticator app can scan, for the signed-in user's email at the app's name, as generateQrCodeUrl(email, app.name). It fails without a signed-in user with an email, except on JS and Wasm, where the JS SDK names the account unknownuser then.
A URL of a QR code the authenticator app can scan, for accountName at issuer.
A URL of a QR code the authenticator app can scan, for the signed-in user's email at the app's name, as generateQrCodeUrl(email, app.name). It fails without a signed-in user with an email, except on JS and Wasm, where the JS SDK names the account unknownuser then.
A URL of a QR code the authenticator app can scan, for accountName at issuer.
Opens qrCodeUrl in the authenticator app.
Android only: opens qrCodeUrl in an authenticator app from activity, or fallbackUrl when none is installed.
Opens qrCodeUrl in the authenticator app.
Opens qrCodeUrl in the authenticator app.
Opens qrCodeUrl in the authenticator app.
Opens qrCodeUrl in the authenticator app.