Class MFA

Multi-Factor Authentication

Constructors

constructor

Accessors

authenticatorEnabled availableMethods recoveryEnabled

Methods

createTicket enableAuthenticator

Constructors

constructor

  • new MFA(
        client: Client,
        state: {
            email_mfa: boolean;
            email_otp: boolean;
            recovery_active: boolean;
            security_key_mfa: boolean;
            totp_mfa: boolean;
            trusted_handover: boolean;
        },
    ): MFA

    Construct MFA helper

    Parameters

    • client: Client

      Client

    • state: {
          email_mfa: boolean;
          email_otp: boolean;
          recovery_active: boolean;
          security_key_mfa: boolean;
          totp_mfa: boolean;
          trusted_handover: boolean;
      }

      State

    Returns MFA

Accessors

authenticatorEnabled

  • get authenticatorEnabled(): boolean

    Whether authenticator app is enabled

    Returns boolean

availableMethods

  • get availableMethods(): ("Password" | "Recovery" | "Totp")[]

    Available MFA methods for generating tickets

    Returns ("Password" | "Recovery" | "Totp")[]

recoveryEnabled

  • get recoveryEnabled(): boolean

    Whether recovery codes are enabled

    Returns boolean

Methods

createTicket

  • createTicket(
        params:
            | { password: string }
            | { recovery_code: string }
            | { totp_code: string },
    ): Promise<MFATicket>

    Create an MFA ticket

    Parameters

    • params: { password: string } | { recovery_code: string } | { totp_code: string }

    Returns Promise<MFATicket>

    Token

enableAuthenticator

  • enableAuthenticator(token: string): Promise<void>

    Enable authenticator using token generated from secret found earlier

    Parameters

    • token: string

      Token

    Returns Promise<void>

On This Page

Constructors
Accessors
Methods