Interstitial Captcha screen class

The Interstitial Captcha screen class is part of the Identifier First Authentication flow and is presented based on the tenant settings. For more details, review Bot Detection.

Import and instantiate the Interstitial Captcha screen class:

import InterstitialCaptcha from "@auth0/auth0-acul-js/interstitial-captcha";
const interstitialCaptcha = new InterstitialCaptcha();

// SDK Properties return a string, number or boolean
// ex. "interstitial-captcha"
interstitialCaptcha.screen.name;

// SDK Methods return an object or array
// ex. { email: "[e-mail]" } 
interstitialCaptcha.screenData();

Properties

The Interstitial Captcha screen class properties are:

branding

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 Interstitial Captcha screen class method is:

submitCaptcha( options? )

This method verifies the captcha response and directs the user to the next step.

interstitialCaptchaManager.submitCaptcha({
  captcha: <CaptchaCodeResponse>
});

Parameter	Type	Required	Description
captcha	string	Yes	The captcha code or response from the captcha provider.
[key: string]	string | number | boolean | undefined	No	Additional data collected from the user.