Kotlin: Enroll a factor

Enrolls a new factor.

• Currently, totp is the only supported factorType. The returned id should be used to create a challenge.
• To create a challenge, see mfa.createChallenge().
• To verify a challenge, see mfa.verifyChallenge().
• To create and verify a challenge in a single step, see mfa.createChallengeAndVerify().

Parameters

• factorType

  (Required)

  The type of MFA factor to enroll. Currently only supports `FactorType.TOTP`.

• issuer

  (Optional)

  Domain which the user is enrolling with.

• friendlyName

  (Optional)

  Human readable name assigned to a device.

Examples

Enroll a time-based, one-time password (TOTP) factor

val factor = supabase.auth.mfa.enroll(factorType = FactorType.TOTP)

// Use the id to create a challenge.
// The challenge can be verified by entering the code generated from the authenticator app.
// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.
val (id, type, qrCode) = factor.data //qrCode is a svg as a string
val (factorId, factorType, _) = factor

Check the local user for verified factors

val verifiedFactors = supabase.auth.mfa.verifiedFactors

Retrieve verified factors

val verifiedFactors = supabase.auth.mfa.retrieveFactorsForCurrentUser()