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

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

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

tenant · TenantMembers

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

transaction · TransactionMembers

アクティブな識別子やフローの状態など、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 · 必須

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