MfaCountryCodes

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

MfaCountryCodes クラスは、mfa-country-codes 画面の機能を実装します。この画面では、MFA の電話番号確認に使用する国番号をユーザーが選択できます。

​

コンストラクタ

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

Example

import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';

const mfaCountryCodes = new MfaCountryCodes();
await mfaCountryCodes.selectCountryCode({
  country_code: 'US',
  phone_prefix: '+1',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaCountryCodes

設定やコンテキストなど、mfa-country-codes 画面に固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA 国番号の選択時のユーザー入力など、SDK に渡される未検証データを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';
const mfaCountryCodes = new MfaCountryCodes();
mfaCountryCodes.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

goBack · Promise<void>

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

Example

import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';
const mfaCountryCodes = new MfaCountryCodes();
await mfaCountryCodes.goBack();

selectCountryCode · Promise<void>

このメソッドは、利用可能な選択肢から国番号を選択します。

Example

import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';

const mfaCountryCodes = new MfaCountryCodes();
await mfaCountryCodes.selectCountryCode({
  country_code: 'US',
  phone_prefix: '+1',
});

メソッドパラメーター

表示 パラメーター

options

SelectCountryCodeOptions。

country_code · string · 必須

国番号です (例: 'US'、'GB') 。

phone_prefix · string · 必須

電話番号のプレフィックスです (例: '+1'、'+44') 。