ResetPasswordMfaSmsChallenge

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

ResetPasswordMfaSmsChallenge クラスは、reset-password-mfa-sms-challenge 画面の機能を実装します。この画面では、パスワードのリセットフロー中の MFA ステップの一環として、SMS で電話に送信された認証コードを入力するようユーザーに求めます。

​

コンストラクタ

ResetPasswordMfaSmsChallenge スクリーンマネージャーのインスタンスを作成します。

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.continueMfaSmsChallenge({
  code: '123456',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnResetPasswordMfaSmsChallenge

設定やコンテキストを含む、reset-password-mfa-sms-challenge 画面固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continueMfaSmsChallenge · Promise<void>

このメソッドは、パスワードリセットフロー中の MFA チャレンジを続行するために、SMS 認証コードを送信します。

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.continueMfaSmsChallenge({
  code: '123456',
});

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaSmsChallengeOptions。

code · string · 必須

ユーザーが入力した SMS 認証コードです。

getACall · Promise<void>

このメソッドは、SMS ではなく音声通話による認証に切り替えます。

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.getACall();

getErrors · Error []

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

resendCode · Promise<void>

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

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.resendCode();

resendManager · ResendControl

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

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
const { startResend } = resetPasswordMfaSmsChallengeManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// ユーザーが再送ボタンをクリックしたときに startResend を呼び出す
startResend();

メソッドのパラメーター

表示 パラメーター

options

StartResendOptions。

timeoutSeconds? · number

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

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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

tryAnotherMethod · Promise<void>

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

Example

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallengeManager = new ResetPasswordMfaSmsChallenge();
await resetPasswordMfaSmsChallengeManager.tryAnotherMethod();