MfaSmsEnrollment

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

MfaSmsEnrollment クラスは、mfa-sms-enrollment 画面の機能を提供します。この画面は、ユーザーが SMS ベースの MFA 用に電話番号を登録する必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaSmsEnrollment

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
mfaSmsEnrollment.changeLanguage({
  language: 'fr',
});

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continueEnrollment · Promise<void>

このメソッドは、指定した電話番号で SMS の登録プロセスを続行します。

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.continueEnrollment({ phone: '1234567890' });

メソッドのパラメーター

表示 パラメーター

options

MfaSmsEnrollmentOptions。

captcha? · string

CAPTCHA プロバイダーからの CAPTCHA コードまたはレスポンスです。Auth0 テナントでボット検出が有効になっている場合は必須です。

phone? · string

ユーザーの電話番号です。

getErrors · Error []

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

pickCountryCode · Promise<void>

このメソッドは、ユーザーが電話番号の国番号を選択できる画面に移動します。

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.pickCountryCode();

tryAnotherMethod · Promise<void>

このメソッドでは、ユーザーは別のMFA方式を試すことができます。

Example

import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment';

const mfaSmsEnrollment = new MfaSmsEnrollment();
await mfaSmsEnrollment.tryAnotherMethod();