InterstitialCaptcha

Universal Login の interstitial-captcha 画面をカスタマイズするために利用できる、すべてのプロパティとメソッドについて説明します。

InterstitialCaptcha クラスは、interstitial-captcha 画面の機能を提供します。この画面では、認証フロー中にユーザーに CAPTCHA チャレンジへの対応を求めます。

​

コンストラクター

InterstitialCaptcha 画面マネージャーのインスタンスを作成します:

Example

import InterstitialCaptcha from '@auth0/auth0-acul-js/interstitial-captcha';
const interstitialCaptchaManager = new InterstitialCaptcha();
await interstitialCaptchaManager.submitCaptcha({ captcha: 'captchaValue' });

​

プロパティ

branding · BrandingMembers

ブランディングテーマや設定など、ブランディング関連の構成を提供します。

client · ClientMembers

interstitial-captcha 画面向けに、id、name、logoUrl などのクライアント関連の設定を提供します。

organization · OrganizationMembers

ユーザーの組織に関する情報 (id や name など) を提供します。

prompt · PromptMembers

認証フロー内の現在の prompt に関するデータを含みます。

screen · ScreenMembers

interstitial-captcha 画面に固有の詳細 (設定やコンテキストを含む) を含みます。

tenant · TenantMembers

id や関連するメタデータなど、テナントに関連するデータを含みます。

transaction · TransactionMembers

アクティブな識別子やフローの状態など、interstitial-captcha 画面向けのトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

CAPTCHA チャレンジフロー中のユーザー入力など、SDK に渡される未検証のデータを扱います。

user · UserMembers

アクティブなユーザーの詳細 (username、email、roles を含む) を含みます。

​

メソッド

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import InterstitialCaptcha from '@auth0/auth0-acul-js/interstitial-captcha';
const interstitialCaptchaManager = new InterstitialCaptcha();
interstitialCaptchaManager.changeLanguage({
  language: 'fr',
});

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語がセッション中保持されます。

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。エラーがない場合は空の配列を返します。

submitCaptcha · Promise<void>

このメソッドは、認証フローを続行するために CAPTCHA の応答を送信します。

Example

import InterstitialCaptcha from '@auth0/auth0-acul-js/interstitial-captcha';
const interstitialCaptchaManager = new InterstitialCaptcha();
await interstitialCaptchaManager.submitCaptcha({ captcha: 'captchaValue' });

メソッドのパラメーター

表示 パラメーター

options

SubmitCaptchaOptions。

captcha · string · 必須

CAPTCHA の応答トークンです。