Interstitial Captcha Screen

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

Interstitial Captcha

Context Data

The Universal Login Context Data contains unique-per-screen transaction and configuration data. Optional context data can be configured in the Management API with the context_configuration parameter. Read Universal Login Context for information about context data and read Configure Screens for details about optional context data.

interface InterstitialCaptcha {
  client: Client;
  organization?: Organization;
  prompt: Prompt;
  screen: {
    name: string;
    captcha: Captcha;
  };
  transaction: Transaction;
};

Was this helpful?

/

Accessing Context Data

Using the Auth0 ACUL JS SDK to access the context data for each screen is recommended. The SDK provides properties and methods that simplify accessing the data.

Initialize the InterstitialCaptcha class to access its properties and methods.

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

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

Was this helpful?

/

SDK Properties & Methods

The following properties and methods are available on this screen.

The following groups of properties and methods are available on all screens. To learn more, read Auth0 ACUL JS SDK Shared Properties.

Property or Method Group Description
branding Information about the branding settings and default theme.
client Information about the client (i.e. Auth0 Application).
organization Information about the organization. This is only present if the client is part of an organization.
prompt Information about the current prompt.
screen Information about the current screen.
tenant Information about the Auth0 tenant.
transaction Information about the current authentication transaction.
unstrustedData Information submitted by the user that could potentially be unsafe, as well as certain parameters and custom query parameters passed to the /authorize call.

Screen Operations

The Interstitial Captcha screen supports the following operations.

Submit Captcha

Continue the transaction after verifying the captcha response. This operation verifies the captcha response and directs the user to the next step.

JS SDK Method: submitCaptcha()

Parameter Type Required Description
captcha string Yes The captcha code or response from the captcha provider. 

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

Was this helpful?

/