ResetPasswordMfaPhoneChallenge

Universal Login の reset-password-mfa-phone-challenge 画面をカスタマイズするために利用可能な、すべてのプロパティとメソッドについて説明します。

ResetPasswordMfaPhoneChallenge クラスは、reset-password-mfa-phone-challenge 画面の機能を提供します。この画面では、パスワードリセットフロー中の MFA ステップの一環として、ユーザーが SMS または音声通話で確認コードをリクエストできます。

​

コンストラクター

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

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
await resetPasswordMfaPhoneChallengeManager.continue({
  type: 'sms',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

reset-password-mfa-phone-challenge 画面向けの、id、name、logoUrl などのクライアント関連の構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnResetPasswordMfaPhoneChallenge

reset-password-mfa-phone-challenge 画面に固有の詳細 (設定やコンテキストなど) を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

有効な識別子やフローの状態など、reset-password-mfa-phone-challenge 画面におけるトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
resetPasswordMfaPhoneChallengeManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、選択した配信方法でユーザーの電話番号に確認コードを送信し、パスワードリセットフロー中の MFAチャレンジを続行します。

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
await resetPasswordMfaPhoneChallengeManager.continue({
  type: 'sms',
});

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaPhoneChallengeContinueOptions。

type · "sms" | "voice" · 必須

確認コードの配信方法です。テキストメッセージで送信する場合は sms、音声通話で送信する場合は voice を使用します。

getErrors · Error []

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

tryAnotherMethod · Promise<void>

このメソッドを使用すると、ユーザーはチャレンジを完了するために別の MFA方式 を選択できます。

Example

import ResetPasswordMfaPhoneChallenge from '@auth0/auth0-acul-js/reset-password-mfa-phone-challenge';
const resetPasswordMfaPhoneChallengeManager = new ResetPasswordMfaPhoneChallenge();
await resetPasswordMfaPhoneChallengeManager.tryAnotherMethod({
  type: 'sms',
});

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions。

type? · "sms" | "voice"

現在の画面で提示されている配信方法です。方式の切り替えを API が正しく処理するために必要です。