ResetPasswordMfaWebauthnPlatformChallenge

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

reset-password-mfa-webauthn-platform-challenge 画面は、プラットフォームパスキーによる多要素認証が必要な場合に、パスワードリセットフロー中に表示されます。この画面では、リセット処理を続行するために、デバイスに保存されているパスキーを使用して認証するようユーザーに求めます。

​

インポート

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

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

Import Example

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

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

function ResetPasswordMfaWebAuthnPlatformChallengeScreen() {
  const { continueWithPasskey } = useResetPasswordMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => continueWithPasskey()}>
      Authenticate with Passkey
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、reset-password-mfa-webauthn-platform-challenge 画面に対応するクライアントの id、name、logoUrl などの設定を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordMfaWebAuthnPlatformChallenge · ResetPasswordMfaWebAuthnPlatformChallengeMembers

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

​

メソッド

continueWithPasskey · Promise<void>

このメソッドは、パスワードリセットフローで MFA ステップを続行するために、プラットフォームパスキーのチャレンジを開始します。

Example

import { useResetPasswordMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-platform-challenge';

function ContinueWithPasskeyButton() {
  const { continueWithPasskey } = useResetPasswordMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => continueWithPasskey()}>
      Authenticate with Passkey
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.

rememberDevice? · boolean

true で、かつ screen.showRememberDevice も true の場合、現在のブラウザーからの今後のログインでは MFA をスキップします。

reportBrowserError · Promise<void>

このメソッドは、ユーザーのデバイスでパスキーチャレンジが失敗した場合に、WebAuthn のブラウザーエラーを Auth0 に報告します。

Example

import { useResetPasswordMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-platform-challenge';

function HandlePasskeyError() {
  const { reportBrowserError } = useResetPasswordMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => reportBrowserError({ error: { name: 'NotAllowedError', message: 'User cancelled' } })}>
      Report Error
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · 必須

報告対象となる WebAuthn API (navigator.credentials.get()) のエラーオブジェクトです。

name · string · 必須

エラーの名前です (例: 'NotAllowedError') 。

message · string · 必須

何が問題だったかを説明するエラーメッセージです。

tryAnotherMethod · Promise<void>

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

Example

import { useResetPasswordMfaWebAuthnPlatformChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-platform-challenge';

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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