MfaEmailList

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

MfaEmailList クラスは、mfa-email-list 画面の機能を実装します。この画面では、ユーザーは MFA に使用する登録済みのメールアドレスを選択できます。

​

コンストラクター

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

Example

import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';

const mfaEmailList = new MfaEmailList();
await mfaEmailList.selectMfaEmail({
  index: 0
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaEmailList

設定やコンテキストを含む、mfa-email-list 画面固有の詳細を含みます。

tenant · TenantMembers

id や関連するメタデータなど、tenant に関連するデータを含みます。

transaction · TransactionMembers

アクティブな identifier やフローの状態など、mfa-email-list 画面に固有の transaction データを提供します。

untrustedData · UntrustedDataMembers

MFA のメール一覧選択時のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在アクティブなユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

goBack · Promise<void>

このメソッドは、前の画面に戻ります。

Example

import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';

const mfaEmailList = new MfaEmailList();
await mfaEmailList.goBack();

selectMfaEmail · Promise<void>

このメソッドは、一覧から登録済みのメールアドレスを選択します。

Example

import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list';

const mfaEmailList = new MfaEmailList();
await mfaEmailList.selectMfaEmail({
  index: 0
});

メソッドのパラメーター

表示 パラメーター

options

SelectMfaEmailOptions。

index · number · 必須

選択するメールアドレスのインデックスです。