Auth0 Universal Components
    Preparing search index...

    Interface UseMFALogicOptions

    Options for useMFALogic hook.

    interface UseMFALogicOptions {
        confirmEnrollment?: (
            factorType: MFAType,
            authSession: string,
            authenticationMethodId: string,
            options: ConfirmEnrollmentOptions,
        ) => Promise<unknown>;
        customMessages?: Partial<MFAMessages>;
        deleteMfa: (authenticatorId: string) => Promise<void>;
        disableDelete?: boolean;
        enrollMfa?: (
            factorType: MFAType,
            options?: EnrollOptions,
        ) => Promise<CreateAuthenticationMethodResponseContent>;
        factorConfig?: Partial<Record<MFAType, FactorConfigOptions>>;
        fetchFactors: (onlyActive?: boolean) => Promise<unknown>;
        onBeforeAction?: (
            action: "enroll" | "delete" | "confirm",
            factorType: MFAType,
        ) => boolean | Promise<boolean>;
        onDelete?: () => void;
        onEnroll?: () => void;
        onErrorAction?: (
            error: Error,
            action: "enroll" | "delete" | "confirm",
        ) => void;
        onFetch?: () => void;
        readOnly?: boolean;
        showActiveOnly?: boolean;
    }
    Index

    Properties

    confirmEnrollment?: (
        factorType: MFAType,
        authSession: string,
        authenticationMethodId: string,
        options: ConfirmEnrollmentOptions,
    ) => Promise<unknown>
    customMessages?: Partial<MFAMessages>
    deleteMfa: (authenticatorId: string) => Promise<void>
    disableDelete?: boolean
    enrollMfa?: (
        factorType: MFAType,
        options?: EnrollOptions,
    ) => Promise<CreateAuthenticationMethodResponseContent>
    factorConfig?: Partial<Record<MFAType, FactorConfigOptions>>
    fetchFactors: (onlyActive?: boolean) => Promise<unknown>
    onBeforeAction?: (
        action: "enroll" | "delete" | "confirm",
        factorType: MFAType,
    ) => boolean | Promise<boolean>
    onDelete?: () => void
    onEnroll?: () => void
    onErrorAction?: (error: Error, action: "enroll" | "delete" | "confirm") => void
    onFetch?: () => void
    readOnly?: boolean
    showActiveOnly?: boolean