ResetPasswordMfaEmailChallenge

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

ResetPasswordMfaEmailChallenge クラスは、reset-password-mfa-email-challenge 画面の機能を実装したクラスです。この画面では、パスワードリセットフロー中の MFA ステップの一環として、メールアドレスに送信された確認コードをユーザーに入力してもらいます。

​

コンストラクター

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

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.continue({
  code: '123456',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnResetPasswordMfaEmailChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

アクティブな identifier やフローの状態など、reset-password-mfa-email-challenge 画面に固有のトランザクションデータを提供します。

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドのパラメータ

表示 Parameters

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

'session' に設定すると、選択した言語は session の間維持されます。

continue · Promise<void>

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

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.continue({
  code: '123456',
});

メソッドのパラメータ

表示 Parameters

options

ContinueOptions。

code · string · 必須

ユーザーのメールアドレスに送信された確認コード。

rememberDevice? · boolean

今後の MFA チャレンジのためにデバイスを記憶するかどうか。

getErrors · Error []

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

resendCode · Promise<void>

このメソッドは、ユーザーのメールアドレスに確認コードを再送します。

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.resendCode();

resendManager · ResendControl

このメソッドは、reset-password-mfa-email-challenge 画面に対して、timeout management を含む resend functionality を提供します。

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
const { startResend } = resetPasswordMfaEmailChallengeManager.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

ユーザーが code を再送できるようになるまでの待機秒数。

onStatusChange? · OnStatusChangeCallback

resend status が変化するたびに呼び出されるコールバックです。残り秒数と、resend functionality が現在無効かどうかを返します。

onTimeout? · void

timeout が終了し、再送ボタンが利用可能になったときに実行されるコールバック。

tryAnotherMethod · Promise<void>

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

Example

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallengeManager = new ResetPasswordMfaEmailChallenge();
await resetPasswordMfaEmailChallengeManager.tryAnotherMethod();