MfaPushWelcome

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

MfaPushWelcome クラスは、mfa-push-welcome 画面の機能を提供します。

​

コンストラクタ

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

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.enroll();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaPushWelcome

構成やコンテキストを含む、mfa-push-welcome 画面固有の詳細情報を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

有効な識別子やフローの状態など、mfa-push-welcome 画面におけるトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッド パラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

enroll · Promise<void>

このメソッドは登録画面に遷移します。

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.enroll();

getErrors · Error []

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

pickAuthenticator · Promise<void>

このメソッドは、認証方法の選択画面に遷移します。

Example

import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome';

const mfaPushWelcome = new MfaPushWelcome();
await mfaPushWelcome.pickAuthenticator();