MfaWebauthnPlatformChallenge

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

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

​

インポート

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

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

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

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

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 フローの state など、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()) のエラーオブジェクトです。

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 の場合にのみ適用されます。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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