MfaEmailChallenge

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

MfaEmailChallenge クラスは、mfa-email-challenge 画面の機能を実装します。この画面は、MFA の際にユーザーがメールアドレスの確認を求められる場合に表示されます。

​

コンストラクター

MFA メールチャレンジ 画面マネージャーのインスタンスを作成します。

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaEmailChallenge

設定やコンテキストなど、mfa-email-challenge 画面に固有の詳細情報が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembersOnMfaEmailChallenge

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、指定したコードを使用してメールチャレンジを続行します。

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true
});

メソッドパラメーター

表示 パラメーター

options

ContinuePayloadOptions。

code · string · 必須

ユーザーが入力したコード。

rememberDevice? · boolean

デバイスを記憶するかどうかを指定します。

getErrors · Error []

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

pickEmail · Promise<void>

このメソッドは、利用可能な場合、別の Email 設定を選択するアクションを送信します。

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.pickEmail();

resendCode · Promise<void>

このメソッドは、メールコードを再送します。

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';
const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.resendCode();

resendManager · ResendControl

このメソッドは、この画面で再送機能をタイムアウト管理付きで提供します。

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
const { startResend } = mfaEmailChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`再送は${remainingSeconds}秒後に利用可能、無効: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('再送が利用可能になりました');
  }
});

// ユーザーが再送ボタンをクリックしたときに startResend を呼び出します
startResend();

メソッドパラメーター

表示 パラメーター

options

StartResendOptions。

timeoutSeconds? · number

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

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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

tryAnotherMethod · Promise<void>

このメソッドを使用すると、ユーザーは別の MFA 方法を試すことができます。

Example

import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge';

const mfaEmailChallenge = new MfaEmailChallenge();
await mfaEmailChallenge.tryAnotherMethod();