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 API のブラウザーエラーを 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

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