MfaSmsList

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

MfaSmsList クラスは、mfa-sms-list 画面の機能を提供します。この画面は、ユーザーが SMS ベースの MFA 用に登録済みの電話番号を選択する必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.selectPhoneNumber({ index: 0 });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

mfa-sms-list 画面で使用される、id、name、logoUrl などのクライアント関連の構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

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

tenant · TenantMembers

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

transaction · TransactionMembers

アクティブな identifier やフローの state など、mfa-sms-list 画面に固有のトランザクション データを提供します。

untrustedData · UntrustedDataMembers

MFA の SMS リスト選択時のユーザー入力など、SDK に渡される信頼できないデータを処理します。

user · UserMembers

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

​

メソッド

backAction · Promise<void>

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

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.backAction();

changeLanguage · Promise<void>

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

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
mfaSmsList.changeLanguage({
  language: 'fr',
});

メソッド パラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

selectPhoneNumber · Promise<void>

このメソッドは、登録済み電話番号の一覧から電話番号を選択します。

Example

import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list';

const mfaSmsList = new MfaSmsList();
await mfaSmsList.selectPhoneNumber({ index: 0 });

メソッド パラメーター

表示 パラメーター

options

MfaSmsListOptions。

index · number · 必須

選択する電話番号のインデックス。