Setu-TS
    Preparing search index...

    Interface TotpEnrolment

    A TOTP enrolment record.

    interface TotpEnrolment {
        confirmed: boolean;
        label: string;
        lastClaimedStep: number;
        pendingLabel?: string;
        pendingSecret?: string;
        secret: string;
    }
    Index
    confirmed label lastClaimedStep pendingLabel? pendingSecret? secret
    confirmed: boolean

    Whether the enrolment has been confirmed with a valid code.

    label: string

    The label shown in the authenticator app, belonging to secret.

    lastClaimedStep: number

    The last claimed TOTP step; a step must be greater than this to be accepted. Monotonic across re-enrolment: a step claimed under the old secret stays claimed after the new one is confirmed.

    pendingLabel?: string

    The label belonging to pendingSecret.

    pendingSecret?: string

    The base32 secret of a re-enrolment awaiting confirmation, if one is in progress. Only ITotpStore and the confirmation path read it; verification of a confirmed factor uses secret alone.

    secret: string

    The base32 secret (RFC 4648, no padding) that verifies today. While a re-enrolment awaits confirmation this stays the OLD confirmed secret, so beginning a new enrolment never removes the working factor.

    Settings
    Member Visibility

    On This Page
    Properties