Skip to main content
function EnrollMfa(props: EnrollMfaProps): Element;
A component for MFA enrollment. Guides users through setting up two-factor authentication.

​
Parameters

ParameterTypeDescription
propsEnrollMfaPropsThe props for the component.

​
Returns

Element The rendered component.

​
Examples

// Default usage
<EnrollMfa onEnrollSuccess={() => console.log("Enrolled!")} />

// With custom UI
<EnrollMfa onEnrollSuccess={onEnrollSuccess}>
  {(state) => (
    <>
      <h1>{state.step === "list" ? "Multi-factor authentication" : "Add new method"}</h1>
      <EnrollMfaTitle />
      <EnrollMfaDescription />
      {state.step === "list" && <EnrollMfaError />}
      <EnrollMfaFlow />
    </>
  )}
</EnrollMfa>

​
Further reading