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

​

コンテキストフック

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

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

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パラメーター から渡されるユーザー名など、画面に渡される信頼できないデータを扱います。

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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