Skip to main content

Interface: TOTPEnrollment

Defined in: src/types/interfaces/mfa.interface.ts:30

TOTP enrollment result.

Properties​

backupCodes​

readonly backupCodes: readonly string[]

Defined in: src/types/interfaces/mfa.interface.ts:58

Recovery codes for backup.

Remarks​

10 single-use codes generated during enrollment. Should be displayed to user only once.

enrollmentId​

readonly enrollmentId: string

Defined in: src/types/interfaces/mfa.interface.ts:34

Enrollment identifier.

secret​

readonly secret: string

Defined in: src/types/interfaces/mfa.interface.ts:42

Base32-encoded secret for authenticator app.

Remarks​

Should be displayed to user only once during enrollment.

uri​

readonly uri: string

Defined in: src/types/interfaces/mfa.interface.ts:49

otpauth:// URI for QR code generation.

Example​

"otpauth://totp/Chive:alice@example.com?secret=JBSWY3DPEHPK3PXP&issuer=Chive"