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 など) を提供します。

prompt · PromptMembers

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

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();