ResetPasswordMfaRecoveryCodeChallenge

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

reset-password-mfa-recovery-code-challenge 画面は、リカバリーコードによる多要素認証が必要な場合に、パスワードリセットフロー中に表示されます。ユーザーにリカバリーコードの入力を求め、リセットプロセスを続行できるようにします。

​

インポート

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

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

Import Example

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

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

function ResetPasswordMfaRecoveryCodeChallengeScreen() {
  const { continueMethod } = useResetPasswordMfaRecoveryCodeChallenge();
  return (
    <button onClick={() => continueMethod('ABC123')}>
      Verify Recovery Code
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、reset-password-mfa-recovery-code-challenge 画面で使用される id、name、logoUrl などのクライアント関連の設定を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-recovery-code-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-recovery-code-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URL パラメーターから事前入力されたメールアドレスや username など、画面に渡される信頼できないデータを扱います。

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordMfaRecoveryCodeChallenge · ResetPasswordMfaRecoveryCodeChallengeMembers

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

​

メソッド

continueMethod · Promise<void>

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

Example

import { useResetPasswordMfaRecoveryCodeChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-recovery-code-challenge';

function VerifyRecoveryCodeForm() {
  const { continueMethod } = useResetPasswordMfaRecoveryCodeChallenge();
  return (
    <button onClick={() => continueMethod('ABC123')}>
      Verify Recovery Code
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

code · string · 必須

ユーザーが入力したリカバリーコード。

tryAnotherMethod · Promise<void>

このメソッドは、別の MFA 方式を選択する画面にユーザーを遷移させます。

Example

import { useResetPasswordMfaRecoveryCodeChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-recovery-code-challenge';

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

​

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

useAuth0Themes · Hooks

このフックは、ブランディングコンテキストのフラット化された構成を含む現在のテーマオプションを取得します。

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

このフックは、画面上のサーバーエラー、クライアントエラー、開発者エラーを参照および管理します。