Multi-Factor Authentication Voice screen classes

MFA Voice Challenge screen class

The Voice Challenge screen class provides methods associated with the mfa-voice-challenge screen. This screen is displayed when the user needs to enter a recovery code to verify their identity.

Import and instantiate the MFA Voice Challenge screen class:

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';
const mfaVoiceChallenge = new MfaVoiceChallenge();

Properties

The MFA Voice Challenge screen class properties are:

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | {
    phoneNumber?: string;
    rememberDevice?: boolean;
  };
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

Methods

The MFA Voice Challenge screen class methods are:

continue( options? )

This method continues the voice challenge flow.

import MfaVoiceChallenge from '@auth0/auth0-acul-js/mfa-voice-challenge';
const mfaVoiceChallenge = new MfaVoiceChallenge();

// Submit the verification code the user received via voice call
mfaVoiceChallenge.continue({
  code: '123456',
  rememberBrowser: true // Optional: to remember this device for 30 days
});

Parameter	Type	Required	Description
`code`	string	Yes	The code entered by the user.
`rememberBrowser`	boolean	No	Remember the user’s browser configuration.

pickPhone( options ?)

This method redirects the user to a phone selection screen.

const mfaVoiceChallenge = new MfaVoiceChallenge();

// Navigate to the screen for selecting a different phone number
mfaVoiceChallenge.pickPhone();

resendCode( options ?)

This method requests a new voice call with a verification code.

const mfaVoiceChallenge = new MfaVoiceChallenge();

// Request a new voice call with verification code
mfaVoiceChallenge.resendCode();

switchToSms( options? )

This method switches the user from voice confirmation to SMS confirmation.

const mfaVoiceChallenge = new MfaVoiceChallenge();

// Switch to SMS verification instead of voice call
mfaVoiceChallenge.switchToSms();

tryAnotherMethod( options ?)

This method allows the user to request an alternative MFA method.

const mfaVoiceChallenge = new MfaVoiceChallenge();

// Navigate to the screen for selecting an alternative MFA method
mfaVoiceChallenge.tryAnotherMethod();

MFA Voice Enrollment screen class

The MFA Voice Enrollment screen class provides methods associated with the mfa-voice-enrollment screen. This screen is displayed for a user needs to enter a phone number to receive a voice call with a code to continue enrollment.

Import and instantiate the MFA Voice Enrollment screen class:

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();

Properties

The MFA Voice Enrollment screen class properties are:

interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

interface client {
  description: null | string;
  id: string;
  logoUrl: null | string;
  name: string;
  metadata: null | {[key: string]: string;};
}

interface organization {
  branding: null | {
    colors?: {
      pageBackground?: string;
      primary?: string;
    };
    logoUrl?: string;
  };
  displayName: null | string;
  id: null | string;
  metadata: null | {[key: string]: string;};
  name: null | string;
  usage: null | string;
}

interface prompt{
  name: string;
}

interface screen {
  captcha: null | CaptchaContext;
  captchaImage: null | string;
  captchaProvider: null | string;
  captchaSiteKey: null | string;
  data: null | Record<string,
      | string
      | boolean
      | PasskeyCreate
      | string[]
      | PhonePrefix[]>
      | Record<string, string[]>>;
  isCaptchaAvailable: boolean;
  links: null | Record<string, string>;
  name: string;
  texts: null | Record<string, string>;
}

interface CaptchaContext {
  image?: string;
  provider: string;
  siteKey?: string;
}

interface PhonePrefix {
  country: string;
  country_code: string;
  phone_prefix: string;
}

interface PasskeyCreate {
    public_key: {
        authenticatorSelection: {
            residentKey: string;
            userVerification: string;
        };
        challenge: string;
        pubKeyCredParams: [{ alg: number; type: string }];
        rp: { id: string; name: string };
        user: { displayName: string; id: string; name: string };
    };
}

interface tenant {
  enabledFactors: null | string[];
  enabledLocales: null | string[];
  friendlyName: null | string;
  name: null | string;
}

interface transaction {
  alternateConnections: null | (Connection | EnterpriseConnection)[];
  connectionStrategy: null | string;
  countryCode: null | string;
  countryPrefix: null | string;
  currentConnection: null | Connection;
  errors: null | Error[];  
  hasErrors: boolean;
  locale: string;
  state: string;
}

interface Connection {
  metadata?: Record<string, string>;
  name: string;
  strategy: string;
}

interface EnterpriseConnection {
  metadata?: Record<string, string>;
  name: string;
  options: {
    displayName?: string;
    iconUrl?: string;
    showAsButton: boolean;
  };
  strategy: string;
}

interface untrustedData {
  authorizationParams: null | {
    login_hint?: string;
    screen_hint?: string;
    ui_locales?: string;
    [key: `ext-${string}`]: string;
  };
  submittedFormData: null | {
    [key: string]:
        | string
        | number
        | boolean
        | undefined;
  };
}

interface user {
  appMetadata: null | {[key: string]: string;};
  email: null | string;
  enrolledDevices: null | ShortEntity<"device">[];
  enrolledEmails: null | ShortEntity<"email">[];
  enrolledFactors: null | string[];
  enrolledPhoneNumbers: null | ShortEntity<"phoneNumber">[];
  id: null | string;
  organizations: null | {
    branding: undefined | {logoUrl: undefined | string;};
    displayName: undefined | string;
    organizationId: undefined | string;
    organizationName: undefined | string;
  }[];
  phoneNumber: null | string;
  picture: null | string;
  userMetadata: null | {[key: string]: string;};
  username: null | string;
}

ShortEntity<Key>: {
    id: number;
} & Record<Key, string>

Methods

The MFA Voice Enrollment screen class methods are:

continue( options ?)

This method continues the enrollment process.

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();

// Call the continue method with a phone number
mfaVoiceEnrollment.continue({
    phone: "1234567890"
});

Parameter	Type	Required	Description
`phone`	string	No	The phone number entered by the user.
`[key: string]`	string \| number \| boolean \| undefined	No	Optional data collected from user.

selectPhoneCountryCode( options ?)

This method allows users to pick their country code.

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();

// Call the pickCountryCode method
mfaVoiceEnrollment.selectPhoneCountryCode();

tryAnotherMethod( options ?)

This method asks users to try SMS if they already tried voice, or vice versa.

import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();

// Call the tryAnotherMethod
mfaVoiceEnrollment.tryAnotherMethod();

Brand Customization

Code Customization

Third-Party Customization

Multi-Factor Authentication Voice screen classes

MFA Voice Challenge screen class

Properties

Methods

continue( options? )

pickPhone( options ?)

resendCode( options ?)

switchToSms( options? )

tryAnotherMethod( options ?)

MFA Voice Enrollment screen class

Properties

Methods

continue( options ?)

selectPhoneCountryCode( options ?)

tryAnotherMethod( options ?)

Brand Customization

Code Customization

Third-Party Customization

Documentation Index

​MFA Voice Challenge screen class

​Properties

​Methods

​continue( options? )

​pickPhone( options ?)

​resendCode( options ?)

​switchToSms( options? )

​tryAnotherMethod( options ?)

​MFA Voice Enrollment screen class

​Properties

​Methods

​continue( options ?)

​selectPhoneCountryCode( options ?)

​tryAnotherMethod( options ?)

MFA Voice Challenge screen class

Properties

Methods

continue( options? )

pickPhone( options ?)

resendCode( options ?)

switchToSms( options? )

tryAnotherMethod( options ?)

MFA Voice Enrollment screen class

Properties

Methods

continue( options ?)

selectPhoneCountryCode( options ?)

tryAnotherMethod( options ?)