​
MFA OTP Challenge screen class

The OTP Challenge screen class provides methods associated with the mfa-otp-challenge screen. This screen is shown when a user needs to enter an OTP code during MFA.
Import and instantiate the MFA OTP Challenge screen class: 
import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';
const mfaOtpChallenge = new MfaOtpChallenge();

// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaOtpChallenge.screen.name;

// SDK Methods return an object or array
await mfaOtpChallenge.continue({
  code: '123456',
  rememberBrowser: true
});

​
Properties

The MFA OTP 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>;
  };
}

​
Methods

The MFA OTP Challenge screen class methods are:

​
continue( options ?)

This method continues with the OTP challenge using the provided code. 
import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';
const mfaOtpChallenge = new MfaOtpChallenge();

await mfaOtpChallenge.continue({
  code: '123456',
  rememberBrowser: true
});
Parameter                 TypeRequiredDescription
codestringYesThe code entered by the user.
rememberBrowserbooleanNoRemember the user’s browser configuration.

​
tryAnotherMethod( options ?)

This method allows the user to try another MFA method. 
import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';
const mfaOtpChallenge = new MfaOtpChallenge();

await mfaOtpChallenge.tryAnotherMethod();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
MFA OTP Enrollment Code screen class

The MFA OTP Enrollment Code screen class provides methods associated with the mfa-otp-enrollment-code screen.
Import and instantiate the MFA OTP Enrollment Code screen class: 
import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';
const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();

// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaOtpEnrollmentCode.screen.name;

// SDK Methods return an object or array
await mfaOtpEnrollmentCode.continue({
  code: '123456',
});

​
Properties

The MFA OTP Enrollment Code 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>;
  };
}

​
Methods

The MFA OTP Enrollment Code screen class methods are:

​
continue( options ?)

This method continues the MFA OTP enrollment process by submitting the OTP code. 
import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';
const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();

await mfaOtpEnrollmentCode.continue({
  code: '123456',
});
Parameter                 TypeRequiredDescription
codestringYesThe code entered by the user.

​
tryAnotherMethod( options ?)

This method allows the user to try another MFA method. 
import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';
const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();

await mfaOtpEnrollmentCode.tryAnotherMethod();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
MFA OTP Enrollment QR screen class

The MFA OTP Enrollment QR screen class provides methods associated with the mfa-otp-enrollment-qr screen.
Import and instantiate the MFA OTP Enrollment QR screen class: 
import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';
const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();

// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaOtpEnrollmentQr.screen.name;

// SDK Methods return an object or array
await mfaOtpEnrollmentQr.continue({ code: '123456' });

​
Properties

The MFA OTP Enrollment QR 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>;
  };
}

​
Methods

The MFA OTP Enrollment QR screen class methods are:

​
continue( options ?)

This method continues the MFA OTP enrollment QR process by submitting the OTP code. 
import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';
const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();

await mfaOtpEnrollmentQr.continue({ code: '123456' });
Parameter                 TypeRequiredDescription
codestringYesThe code entered by the user.
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
toggleView( options ?)

This method navigates to the authenticator selection screen. 
import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';
const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();

await mfaOtpEnrollmentQr.toggleView();
Parameter                 TypeRequiredDescription
rememberBrowserbooleanNoRemember the user’s browser configuration.
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
tryAnotherMethod( options ?)

This method allows the user to try another MFA method. 
import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';
const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();

await mfaOtpEnrollmentQr.tryAnotherMethod();
Parameter                 TypeRequiredDescription
rememberBrowserbooleanNoRemember the user’s browser configuration.
[key: string]string | number | boolean | undefinedNoOptional data collected from user.