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 など、ユーザーの組織に関する情報を提供します。

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') 。