EmailIdentifierChallenge

Universal Login の email-identifier-challenge 画面をカスタマイズする際に使用できる、すべてのプロパティとメソッドについて説明します。

EmailIdentifierChallenge クラスは、email-identifier-challenge 画面の機能を実装します。この画面では、本人確認のためにメールアドレスに送信された確認コードを入力するようユーザーに求めます。

​

コンストラクター

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

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.submitEmailChallenge({ code: 'your-code' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

email-identifier-challenge 画面向けの、id、name、logoUrl などのクライアント関連の構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnEmailIdentifierChallenge

構成やコンテキストなど、email-identifier-challenge 画面に固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

アクティブな識別子やフローの状態など、email-identifier-challenge 画面に関するトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

メールアドレスチャレンジフロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
emailIdentifierChallengeManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

resendCode · Promise<void>

このメソッドは、確認コードをユーザーのメールアドレスに再送します。

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.resendCode();

resendManager · ResendControl

このメソッドは、タイムアウト管理付きの再送機能を提供します。再送を実行する startResend() メソッドを持つ ResendControl オブジェクトを返し、ユーザーが再送できるようになるまでクールダウン期間を適用します。

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
const { startResend } = emailIdentifierChallengeManager.resendManager({
  timeoutSeconds: 15,
});
await startResend();

メソッドパラメーター

表示 パラメーター

options

StartResendOptions。

timeoutSeconds? · number

ユーザーが確認コードを再送できるようになるまでのクールダウン時間 (秒) です。

onStatusChange? · OnStatusChangeCallback

再送ステータスが変化するたびに呼び出されるコールバックです。残り秒数と、再送機能が現在無効かどうかを返します。

onTimeout? · () => void

クールダウンが終了して再送が再び可能になったときに呼び出されるコールバックです。

returnToPrevious · Promise<void>

このメソッドは、ユーザーを前の画面に戻します。

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.returnToPrevious();

submitEmailChallenge · Promise<void>

このメソッドは、チャレンジを完了するためにメール確認コードを送信します。

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.submitEmailChallenge({ code: 'your-code' });

メソッドパラメーター

表示 パラメーター

options

EmailChallengeOptions。

code · string · 必須

ユーザーのメールアドレスに送信された確認コードです。

captcha? · string

このテナントで CAPTCHA が有効な場合の CAPTCHA 応答トークンです。