ResetPasswordMfaEmailChallenge

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

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

​

インポート

各画面には、それぞれ固有のフックとメソッドがあります。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

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-email-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>組織コンテキストがありません</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、利用可能な認証方法など、現在のユーザーの詳細情報を提供します。

Example

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

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