EmailOTPChallenge

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

EmailOTPChallenge クラスは、email-otp-challenge 画面の機能を実装します。この画面では、メールアドレスに送信されたワンタイムパスコードの入力をユーザーに求めます。

​

コンストラクター

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

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

username、email、roles など、現在のユーザーの詳細を含みます。

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

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

getErrors · Error []

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

resendCode · Promise<void>

このメソッドは、新しい OTP コードをユーザーのメールアドレスに送信するようリクエストします。

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.resendCode();

resendManager · ResendControl

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

Example

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

メソッドパラメーター

表示 パラメーター

options

StartResendOptions。

timeoutSeconds? · number

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

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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

submitCode · Promise<void>

このメソッドは、ユーザーが入力した OTP コードを送信します。

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

メソッドパラメーター

表示 パラメーター

options

OtpCodeOptions。

code · string · 必須

送信するためにユーザーが入力する OTP コードです。