MfaPhoneChallenge

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

MfaPhoneChallenge クラスは、mfa-phone-challenge 画面の機能を実装します。この画面は、ユーザーが本人確認のためのコードを受け取る必要がある場合に表示されます。

​

コンストラクタ

MFA Phone Challenge 画面マネージャーのインスタンスを生成します。

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.continue({ type: 'sms' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaPhoneChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA Phone Challenge 中のユーザー入力など、SDK に渡される未検証データを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
mfaPhoneChallenge.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、MFA コードの受信方法として SMS または音声通話を選択したユーザーの設定を送信します。

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.continue({ type: 'sms' });

メソッドパラメーター

表示 パラメーター

options

MfaPhoneChallengeContinueOptions。

type · "sms" | "voice" · 必須

MFA コードの受信方法です。

getErrors · Error []

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

pickPhone · Promise<void>

このメソッドは、ユーザーが別の電話番号を選択するプロセスを開始します。

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.pickPhone();

tryAnotherMethod · Promise<void>

このメソッドは、ユーザーが別の MFA 方法を試せるようにします。

Example

import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge';

const mfaPhoneChallenge = new MfaPhoneChallenge();
await mfaPhoneChallenge.tryAnotherMethod();