MfaWebauthnPlatformChallenge

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

mfa-webauthn-platform-challenge 画面では、ユーザーに、デバイスに組み込まれた Touch ID や Windows Hello などのプラットフォーム認証器を使用して MFAチャレンジを完了するよう求めます。

​

インポート

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

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

Import Example

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

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

function MfaWebAuthnPlatformChallengeScreen() {
  const { verify } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Platform Authenticator
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnPlatformChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URLパラメーターから事前入力された値など、画面に渡される未検証のデータを扱います。

Example

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

useUser · () => UserMembers

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

Example

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

useMfaWebAuthnPlatformChallenge · MfaWebAuthnPlatformChallengeMembers

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

​

メソッド

reportBrowserError · Promise<void>

このメソッドは、プラットフォーム認証器のチャレンジ中に発生した、ブラウザレベルの WebAuthn エラーを報告します。

Example

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

function HandleWebAuthnError({ error }) {
  const { reportBrowserError } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => reportBrowserError({ error })}>
      Report Error
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

MfaWebAuthnPlatformChallengeReportErrorOptions.

error · WebAuthnErrorDetails · 必須

報告する WebAuthn API (navigator.credentials.get()) の error object。

name · string · 必須

エラー名 (例: 'NotAllowedError') 。

message · string · 必須

問題の内容を説明するエラーメッセージ。

tryAnotherMethod · Promise<void>

このメソッドは、ユーザーが別の認証要素を選択できるように、MFA方式の選択画面に移動します。

Example

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

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

verify · Promise<void>

このメソッドは、MFAチャレンジを完了するために、プラットフォーム認証器による検証を開始します。

Example

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

function VerifyButton() {
  const { verify } = useMfaWebAuthnPlatformChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Platform Authenticator
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

VerifyPlatformAuthenticatorOptions.

rememberDevice · boolean

任意。true の場合、今後の MFAチャレンジに備えてブラウザを記憶しようとします。 rememberBrowser フォームフィールドに対応します。これは screen.showRememberDevice が true の場合にのみ適用されます。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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