Enroll a factor
Starts the enrollment process for a new Multi-Factor Authentication (MFA) factor. This method creates a new unverified
factor.
To verify a factor, present the QR code or secret to the user and ask them to add it to their authenticator app.
The user has to enter the code from their authenticator app to verify it.
- Currently,
totp
is the only supportedfactorType
. The returnedid
should be used to create a challenge. - To create a challenge, see
mfa.challenge()
. - To verify a challenge, see
mfa.verify()
. - To create and verify a challenge in a single step, see
mfa.challengeAndVerify()
.
Parameters
factorType
Optional
StringType of factor being enrolled.
issuer
Optional
StringDomain which the user is enrolled with.
friendlyName
Optional
StringHuman readable name assigned to the factor.
final res = await supabase.auth.mfa.enroll(factorType: FactorType.totp);
final qrCodeUrl = res.totp.qrCode;