ResetPasswordMfaPushChallengePush

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

reset-password-mfa-push-challenge-push 画面は、プッシュ通知による多要素認証が必要なパスワードリセットフロー中に表示されます。この画面では、リセットプロセスを続行するために、登録済みのモバイルデバイスでリクエストを承認するようユーザーに求めます。

​

インポート

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

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

Import Example

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

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

function ResetPasswordMfaPushChallengePushScreen() {
  const { resendPushNotification } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => resendPushNotification()}>
      Resend Push Notification
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaPushChallengePush

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordMfaPushChallengePush · ResetPasswordMfaPushChallengePushMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、ユーザーがモバイルデバイスでプッシュ通知を承認した後、パスワードリセットフローを続行します。

Example

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

function ContinueButton() {
  const { continueMethod } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

enterCodeManually · Promise<void>

このメソッドは、プッシュ通知の承認を待つ代わりに、OTP コードを手動で入力する画面にユーザーを移動させます。

Example

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

function EnterCodeButton() {
  const { enterCodeManually } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => enterCodeManually()}>
      Enter Code Manually
    </button>
  );
}

resendPushNotification · Promise<void>

このメソッドは、ユーザーの登録済みモバイルデバイスにプッシュ通知を再送します。

Example

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

function ResendButton() {
  const { resendPushNotification } = useResetPasswordMfaPushChallengePush();
  return (
    <button onClick={() => resendPushNotification()}>
      Resend Push Notification
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

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

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

​

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

useMfaPolling · Hooks

このフックは MFA のプッシュ通知のポーリングを管理し、ユーザーがリクエストを承認または拒否するまで、プッシュチャレンジエンドポイントを繰り返し確認します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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