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

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

screen · ScreenMembersOnPhoneIdentifierEnrollment

設定やコンテキストなど、phone-identifier-enrollment 画面に固有の詳細を含みます。screen.data オブジェクトでは、phone、messageType、username の3つのオプションフィールドを利用できます。現在の登録セッションに関連付けられたユーザー名を表示するには、screen.data?.username を使用します。

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',
});

メソッドパラメーター

表示 Parameters

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',
});

メソッドパラメーター

表示 Parameters

options

PhoneEnrollmentOptions.

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

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

getErrors · Error []

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

returnToPrevious · Promise<void>

このメソッドは、ユーザーを前の画面に戻します。

Example

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