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 など、ユーザーの組織に関する情報を提供します。

prompt · PromptMembers

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

screen · ScreenMembersOnResetPasswordMfaSmsChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA challenge フロー中のユーザー入力など、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();

メソッドのパラメータ

表示 Parameters

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