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.
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:
readonlycodeIntervalSeconds:number;
TotpSecret.codeLength
Length of the one-time passwords to be generated.
Signature:
readonlycodeLength:number;
TotpSecret.enrollmentCompletionDeadline
The timestamp (UTC string) by which TOTP enrollment should be completed.
Signature:
readonlyenrollmentCompletionDeadline:string;
TotpSecret.hashingAlgorithm
Hashing algorithm used.
Signature:
readonlyhashingAlgorithm:string;
TotpSecret.secretKey
Shared secret key/seed used for enrolling in TOTP MFA and generating OTPs.
Signature:
readonlysecretKey: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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-01-19 UTC."],[],[],null,["Provider for generating a [TotpMultiFactorAssertion](./auth.totpmultifactorassertion.md#totpmultifactorassertion_interface).\n\nStores 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.\n\n**Signature:** \n\n export declare class TotpSecret \n\nProperties\n\nMethods\n\nTotpSecret.codeIntervalSeconds\n\nThe interval (in seconds) when the OTP codes should change.\n\n**Signature:** \n\n readonly codeIntervalSeconds: number;\n\nTotpSecret.codeLength\n\nLength of the one-time passwords to be generated.\n\n**Signature:** \n\n readonly codeLength: number;\n\nTotpSecret.enrollmentCompletionDeadline\n\nThe timestamp (UTC string) by which TOTP enrollment should be completed.\n\n**Signature:** \n\n readonly enrollmentCompletionDeadline: string;\n\nTotpSecret.hashingAlgorithm\n\nHashing algorithm used.\n\n**Signature:** \n\n readonly hashingAlgorithm: string;\n\nTotpSecret.secretKey\n\nShared secret key/seed used for enrolling in TOTP MFA and generating OTPs.\n\n**Signature:** \n\n readonly secretKey: string;\n\nTotpSecret.generateQrCodeUrl()\n\nReturns 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.\n\n**Signature:** \n\n generateQrCodeUrl(accountName?: string, issuer?: string): string;\n\nParameters\n\n**Returns:**\n\nstring\n\nA QR code URL string."]]
