MfaEmailChallenge

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

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

​

コンストラクター

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

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 など) を提供します。

prompt · PromptMembers

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

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 · 必須

使用する言語の locale コード (たとえば '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>

このメソッドは、利用可能な場合に別のメール設定を選択する操作を送信します。

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(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// ユーザーが再送ボタンをクリックしたときに 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();