auth-kt/io.github.jan.supabase.auth.mfa/MfaApi

MfaApi

sealed interface MfaApi(source)

An interface for interacting with Multi-Factor Authentication Api in GoTrue.

Properties

status

abstract val status: MfaStatus

The current MFA status of the user

statusFlow

abstract val statusFlow: Flow<MfaStatus>

The current MFA status of the user as a flow. This flow will emit a new status any time Auth.sessionStatus changes.

verifiedFactors

abstract val verifiedFactors: List<UserMfaFactor>

Returns all verified factors from the current user session. If the user has no verified factors or there is no session, an empty list is returned. To fetch up-to-date factors, use retrieveFactorsForCurrentUser.

Functions

createChallenge

abstract suspend fun createChallenge(factorId: String, channel: Phone.Channel? = null): MfaChallenge

Creates a new MFA challenge, which can be used to verify the user's code using verifyChallenge

createChallengeAndVerify

open suspend fun createChallengeAndVerify(factorId: String, code: String, channel: Phone.Channel = Phone.Channel.SMS, saveSession: Boolean = true): UserSession

Creates a new MFA challenge and immediately verifies it

enroll

abstract suspend fun <Config, Response> enroll(factorType: FactorType<Config, Response>, friendlyName: String? = null, config: Config.() -> Unit = {}): MfaFactor<Response>

getAuthenticatorAssuranceLevel

abstract fun getAuthenticatorAssuranceLevel(): MfaLevel

Parses the current JWT and returns the AuthenticatorAssuranceLevel for the current session and the next session

retrieveFactorsForCurrentUser

abstract suspend fun retrieveFactorsForCurrentUser(): List<UserMfaFactor>

Retrieves all factors for the current user. This will make a network request to fetch the factors. Use verifiedFactors to get the factors from the current session.

unenroll

abstract suspend fun unenroll(factorId: String)

Unenrolls an MFA factor

verifyChallenge

abstract suspend fun verifyChallenge(factorId: String, challengeId: String, code: String, saveSession: Boolean = true): UserSession

Verifies a MFA challenge