PhoneIdentifierEnrollment

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

PhoneIdentifierEnrollment クラスは、phone-identifier-enrollment 画面の機能を実装します。この画面では、ユーザーは希望する確認方法の配信方法を選択して、電話番号を識別子として登録できます。

​

コンストラクター

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

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
await phoneIdentifierEnrollmentManager.continuePhoneEnrollment({
  type: 'voice',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

phone-identifier-enrollment 画面用のクライアント関連の構成 (id、name、logoUrl など) を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnPhoneIdentifierEnrollment

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

電話番号の登録フローでのユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
phoneIdentifierEnrollmentManager.changeLanguage({
  language: 'fr',
});

メソッド パラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

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

continuePhoneEnrollment · Promise<void>

このメソッドは、選択した配信方法で電話番号の登録を続行します。

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
await phoneIdentifierEnrollmentManager.continuePhoneEnrollment({
  type: 'voice',
});

メソッド パラメーター

表示 パラメーター

options

PhoneEnrollmentOptions。

type · "text" | "voice" · 必須

確認コードの配信方法です。

getErrors · Error []

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

returnToPrevious · Promise<void>

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

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
await phoneIdentifierEnrollmentManager.returnToPrevious();