Class MFA

Multi-Factor Authentication

Hierarchy

  • MFA

Constructors

constructor

Properties

#client #store

Accessors

authenticatorEnabled availableMethods recoveryEnabled

Methods

createTicket enableAuthenticator

Constructors

constructor

  • 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

      • email_mfa: boolean
      • email_otp: boolean
      • recovery_active: boolean
      • security_key_mfa: boolean
      • totp_mfa: boolean
      • trusted_handover: boolean

    Returns MFA

Properties

Private #client

#client: Client

Private #store

#store: [{
    email_mfa: boolean;
    email_otp: boolean;
    recovery_active: boolean;
    security_key_mfa: boolean;
    totp_mfa: boolean;
    trusted_handover: boolean;
}, SetStoreFunction<{
    email_mfa: boolean;
    email_otp: boolean;
    recovery_active: boolean;
    security_key_mfa: boolean;
    totp_mfa: boolean;
    trusted_handover: boolean;
}>]

Type declaration

  • email_mfa: boolean
  • email_otp: boolean
  • recovery_active: boolean
  • security_key_mfa: boolean
  • totp_mfa: boolean
  • trusted_handover: boolean

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

  • Create an MFA ticket

    Parameters

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

    Returns Promise<MFATicket>

    Token

enableAuthenticator

  • Enable authenticator using token generated from secret found earlier

    Parameters

    • token: string

      Token

    Returns Promise<void>

On This Page

Generated using TypeDoc