Interface GoTrueMFAApi

Contains the full multi-factor authentication API.

Hierarchy

  • GoTrueMFAApi

Methods

  • Returns the Authenticator Assurance Level (AAL) for the active session.

    • aal1 (or null) means that the user's identity has been verified only with a conventional login (email+password, OTP, magic link, social login, etc.).
    • aal2 means that the user's identity has been verified both with a conventional login and at least one MFA factor.

    Although this method returns a promise, it's fairly quick (microseconds) and rarely uses the network. You can use this to check whether the current user needs to be shown a screen to verify their MFA factors.

    Returns Promise<AuthMFAGetAuthenticatorAssuranceLevelResponse>

Generated using TypeDoc