ResetPasswordMfaOtpChallenge

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

reset-password-mfa-otp-challenge 画面は、パスワードリセットフロー中に OTP を使用した多要素認証が必要な場合に表示されます。この画面では、パスワードのリセットを続行するために、認証器アプリに表示される OTP の入力が求められます。

​

インポート

各画面には、それぞれ固有のHooksとメソッドが用意されています。SDK は、各画面で 部分インポート と ルートインポート の両方をサポートしています。

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

Import Example

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

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

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

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-otp-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>組織コンテキストがありません</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaOtpChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordMfaOtpChallenge · ResetPasswordMfaOtpChallengeMembers

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

​

メソッド

continueMethod · Promise<void>

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

Example

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

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

メソッドのパラメータ

表示 パラメータ

options

ResetPasswordMfaOtpChallengeContinueOptions。

code · string · 必須

ユーザーが入力したOTPコード。

tryAnotherMethod · Promise<void>

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

Example

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

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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