Variable mechanismsFor

Type Declaration

• • (
        username: any,
    ): {
        activated: boolean;
        backupCodes:
            | {
                generatedAt: number;
                hashed?: undefined;
                lastUsedAt: number;
                legacy?: undefined;
                present: boolean;
                remaining: number;
                sealed: boolean;
                total: number;
                usable: boolean;
                used: number;
                why: string;
            }
            | {
                generatedAt: number;
                hashed: boolean;
                lastUsedAt: number;
                legacy: boolean;
                present: boolean;
                remaining: number;
                sealed: boolean;
                total: number;
                usable: boolean;
                used: number;
                why: string;
            };
        disabled: boolean;
        keys: any[];
        mailFactor: {
            held: string;
            optedIn: string;
            verified: boolean;
            why: string;
        };
        mfaKeys: number;
        mfaRequired: boolean;
        mfaRequirement: {
            byAdministrator: boolean;
            byRealm: boolean;
            byUser: boolean;
            offered: boolean;
            required: boolean;
        };
        password: boolean;
        passwordResetLink: { expired: boolean; expires: any };
        primaryKeys: number;
        recoveryAdvised: boolean;
        secondFactor: string;
        totp: boolean;
        totpDetail: {
            algorithm: any;
            digits: any;
            enrolledAt: any;
            lastUsedAt: any;
            period: any;
            sealed: boolean;
            unusable: boolean;
            why: any;
        };
        totpUsable: boolean;
        usable: boolean;
        username: string;
    }

  • Returns what a person holds to sign in with: password, keys by role, the authenticator app and recovery codes.

    Parameters

    • username: any

      the person

    Returns {
        activated: boolean;
        backupCodes:
            | {
                generatedAt: number;
                hashed?: undefined;
                lastUsedAt: number;
                legacy?: undefined;
                present: boolean;
                remaining: number;
                sealed: boolean;
                total: number;
                usable: boolean;
                used: number;
                why: string;
            }
            | {
                generatedAt: number;
                hashed: boolean;
                lastUsedAt: number;
                legacy: boolean;
                present: boolean;
                remaining: number;
                sealed: boolean;
                total: number;
                usable: boolean;
                used: number;
                why: string;
            };
        disabled: boolean;
        keys: any[];
        mailFactor: {
            held: string;
            optedIn: string;
            verified: boolean;
            why: string;
        };
        mfaKeys: number;
        mfaRequired: boolean;
        mfaRequirement: {
            byAdministrator: boolean;
            byRealm: boolean;
            byUser: boolean;
            offered: boolean;
            required: boolean;
        };
        password: boolean;
        passwordResetLink: { expired: boolean; expires: any };
        primaryKeys: number;
        recoveryAdvised: boolean;
        secondFactor: string;
        totp: boolean;
        totpDetail: {
            algorithm: any;
            digits: any;
            enrolledAt: any;
            lastUsedAt: any;
            period: any;
            sealed: boolean;
            unusable: boolean;
            why: any;
        };
        totpUsable: boolean;
        usable: boolean;
        username: string;
    }

    { username, password, primaryKeys, mfaKeys, keys, totp, … }