TOTPResource
An interface that represents a TOTP secret.
- Name
id- Type
string- Description
The unique identifier for this TOTP secret.
- Name
secret?- Type
string- Description
The generated TOTP secret. This is only returned to the client upon creation and cannot be retrieved afterwards.
- Name
uri?- Type
string- Description
A complete TOTP configuration URI including the Issuer, Account, etc that can be pasted to an authenticator app or encoded to a QR code and scanned for convenience. This is only returned to the client upon creation and cannot be retrieved afterwards.
- Name
verified- Type
boolean- Description
A boolean indicating whether this TOTP secret has been verified by the user by providing one code generated with it. TOTP is not enabled on the user unless they have a verified secret.
- Name
backupCodes?- Type
string[]- Description
A set of fresh generated Backup codes. This will be populated if the feature is enabled in your instance and the user doesn't already have backup codes generated.
- Name
createdAt- Type
Date- Description
The date when the TOTP secret was created.
- Name
updatedAt- Type
Date- Description
The date when the TOTP secret was last updated.
Feedback
Last updated on