PhoneIdentifierChallenge

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

PhoneIdentifierChallenge クラスは、phone-identifier-challenge 画面の機能を実装します。この画面では、本人確認のため、電話番号に送信された認証コードの入力をユーザーに求めます。

​

コンストラクタ

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

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.submitPhoneChallenge({
  code: '123456',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

phone-identifier-challenge 画面向けに、id、name、logoUrl などのクライアント関連の設定を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnPhoneIdentifierChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

電話チャレンジフロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在のユーザーの詳細を含みます。

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

resendCode · Promise<void>

このメソッドは、ユーザーの電話番号に認証コードを再送します。

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.resendCode();

resendManager · ResendControl

このメソッドは、タイムアウト管理付きの再送機能を提供します。再送を実行する startResend() メソッドを持つ ResendControl オブジェクトを返し、ユーザーが再度再送できるようになるまでクールダウン期間を適用します。

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
const { startResend } = phoneIdentifierChallengeManager.resendManager({
  timeoutSeconds: 30,
});
await startResend();

メソッドのパラメーター

表示 パラメーター

options

StartResendOptions。

timeoutSeconds? · number

ユーザーが再びコードを再送できるようになるまでのクールダウン時間 (秒) です。

onStatusChange? · OnStatusChangeCallback

再送ステータスが変わるたびに呼び出されるコールバックです。残り秒数と、再送機能が現在無効かどうかを返します。

onTimeout? · () => void

クールダウンが終了し、再送が再び可能になったときに呼び出されるコールバックです。

returnToPrevious · Promise<void>

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

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.returnToPrevious();

submitPhoneChallenge · Promise<void>

このメソッドは、チャレンジを完了するために電話認証コードを送信します。

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.submitPhoneChallenge({
  code: '123456',
});

メソッドのパラメーター

表示 パラメーター

options

PhoneChallengeOptions。

code · string · 必須

ユーザーの電話番号に送信された認証コードです。

captcha? · string

このテナントで CAPTCHA が有効な場合の CAPTCHA 応答トークンです。

switchToText · Promise<void>

このメソッドは、認証コードの受信方法をSMSに切り替えます。

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.switchToText();

switchToVoice · Promise<void>

このメソッドは、認証コードの受信方法を音声通話に切り替えます。

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.switchToVoice();