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();

switchToPassword · Promise<void>

このメソッドは、認証フローをPhone OTPによる確認からパスワードベースの認証に切り替えます。

Example

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