MfaPushList

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

MfaPushList クラスは、mfa-push-list 画面の機能を実装しています。

​

コンストラクタ

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

Example

import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';

const mfaPushList = new MfaPushList();
await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA push list 中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

goBack · Promise<void>

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

Example

import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';

const mfaPushList = new MfaPushList();
await mfaPushList.goBack();

selectMfaPushDevice · Promise<void>

このメソッドは、MFA push を開始するために、一覧から登録済みデバイスを選択します。

Example

import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';

const mfaPushList = new MfaPushList();
await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 });

メソッドパラメーター

表示 パラメーター

options

SelectMfaPushDeviceOptions.

deviceIndex · number · 必須

登録済みデバイスの一覧から選択するデバイスのインデックスです。インデックスは 0 ベースです。