ResetPasswordMfaEmailChallenge

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

reset-password-mfa-email-challenge 画面は、パスワードのリセットフロー中に、メールによる多要素認証が必要な場合に表示されます。リセットを続行するには、メールアドレスに送信された認証コードを入力する必要があります。

​

インポート

各画面には、それぞれ専用のフックとメソッドがあります。SDK は各画面ごとに、部分インポート と ルートインポート をサポートしています。

• 部分インポートを使用すると、特定のユースケースに必要なコードだけを取り込めます。
• ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めるため、想定されるあらゆる画面に対応できる統一ビルドが必要な場合に便利です。

Import Example

// ルートインポート
import { useResetPasswordMfaEmailChallenge } from '@auth0/auth0-acul-react';

// 部分インポート
import {
  useResetPasswordMfaEmailChallenge,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  continueMethod,
  resendCode,
  tryAnotherMethod,
} from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';

function ResetPasswordMfaEmailChallengeScreen() {
  const { continueMethod } = useResetPasswordMfaEmailChallenge();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

コンテキストフック

reset-password-mfa-email-challenge 画面で、Auth0 コンテキストデータへの読み取り専用アクセスを提供する画面スコープのフックです。@auth0/auth0-acul-react/reset-password-mfa-email-challenge からインポートします。

useBranding · () => BrandingMembers

このフックは、reset-password-mfa-email-challenge 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。

Example

import { useBranding } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

このフックは、reset-password-mfa-email-challenge 画面の id、name、logoUrl など、クライアント関連の設定を提供します。

Example

import { useClient } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、パスワードリセットが Organization スコープの場合に、ユーザーの Organization に関する情報を提供します。Organization コンテキストが存在しない場合は null を返します。

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

このフックには、認証フロー内の現在のプロンプトに関するデータが含まれます。

Example

import { usePrompt } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnResetPasswordMfaEmailChallenge

このフックには、設定やコンテキストなど、reset-password-mfa-email-challenge 画面に固有の詳細が含まれます。

Example

import { useScreen } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

このフックには、id や関連メタデータなど、テナントに関するデータが含まれます。

Example

import { useTenant } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

このフックは、reset-password-mfa-email-challenge 画面のトランザクション固有データ (アクティブな接続や現在のフロー状態など) を提供します。

Example

import { useTransaction } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

このフックは、URL パラメータから事前入力されたメールアドレスやユーザー名など、画面に渡される未検証データを扱います。

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

このフックは、username、email、利用可能な認証方法など、現在のユーザーの情報を提供します。

例

import { useUser } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function UserProfile() {
  const user = useUser();
}

useResetPasswordMfaEmailChallenge · ResetPasswordMfaEmailChallengeMembers

このフックは、reset-password-mfa-email-challenge 画面で使用できるすべてのメソッドとコンテキストを返します。

​

メソッド

continueMethod · Promise<void>

このメソッドは、パスワードリセットフローの MFA ステップを続行するために、メールの認証コードを送信します。

Example

import { useResetPasswordMfaEmailChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';

function VerifyCodeForm() {
  const { continueMethod } = useResetPasswordMfaEmailChallenge();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

ContinueOptions。

code · string · 必須

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

rememberDevice · boolean

今後の認証でこのデバイスを記憶するかどうかを指定します。

resendCode · Promise<void>

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

Example

import { useResetPasswordMfaEmailChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';

function ResendButton() {
  const { resendCode } = useResetPasswordMfaEmailChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

tryAnotherMethod · Promise<void>

このメソッドは、別の MFA 方法を選択する画面にユーザーを移動します。

Example

import { useResetPasswordMfaEmailChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useResetPasswordMfaEmailChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}

​

共通/ユーティリティ フック

useResend · Hooks

このフックは、現在の画面における認証コードの再送信のクールダウン状態とタイマーを管理します。

useAuth0Themes · Hooks

このフックは、ブランディングコンテキストから、設定をフラット化した現在のテーマオプションを取得します。

useChangeLanguage · Hooks

このフックは、現在の ACUL 画面の表示言語を変更するための関数を返します。

useCurrentScreen · Hooks

このフックは、現在の画面のコンテキストと状態を取得します。

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者のエラーを読み取り、管理します。