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

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

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

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

onTimeout? · () => void

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

returnToPrevious · Promise<void>

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

Example

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

switchToPassword · Promise<void>

このメソッドは、認証フローを Email OTP による確認からパスワードベースの認証に切り替えます。

Example

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

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 応答トークン。