MfaWebauthnPlatformEnrollment

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

mfa-webauthn-platform-enrollment 画面では、Touch ID や Windows Hello などのプラットフォーム認証器を MFA 認証要素として登録するよう、ユーザーに求めます。

​

インポート

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

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

Import Example

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

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

function MfaWebAuthnPlatformEnrollmentScreen() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </button>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

このフックは、mfa-webauthn-platform-enrollment 画面に表示されるロゴ、色、テーマ設定などの Branding 設定を提供します。

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

このフックには、認証フローにおける現在の prompt に関するデータが含まれます。

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnPlatformEnrollment

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、現在の MFA フローの state など、mfa-webauthn-platform-enrollment 画面に固有の transaction データを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaWebAuthnPlatformEnrollment · MfaWebAuthnPlatformEnrollmentMembers

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

​

メソッド

refuseEnrollmentOnThisDevice · Promise<void>

このメソッドは、現在のデバイスでのプラットフォーム認証器の登録を行わないようにします。

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function RefuseEnrollmentButton() {
  const { refuseEnrollmentOnThisDevice } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => refuseEnrollmentOnThisDevice()}>
      Not on This Device
    </button>
  );
}

reportBrowserError · Promise<void>

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

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

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

メソッド パラメーター

表示 パラメーター

options

ReportBrowserErrorOptions。

error · WebAuthnErrorDetails · 必須

報告対象となる、WebAuthn API (navigator.credentials.create()) から返されたエラーオブジェクト。

name · string · 必須

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

message · string · 必須

問題の内容を示すエラーメッセージ。

snoozeEnrollment · Promise<void>

このメソッドは、プラットフォーム認証器の登録を後で行うように延期します。

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function SnoozeButton() {
  const { snoozeEnrollment } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => snoozeEnrollment()}>
      Remind Me Later
    </button>
  );
}

submitPasskeyCredential · Promise<void>

このメソッドは、プラットフォーム認証器によって作成されたパスキー資格情報を送信し、登録を完了します。

Example

import { useMfaWebAuthnPlatformEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-platform-enrollment';

function EnrollButton() {
  const { submitPasskeyCredential } = useMfaWebAuthnPlatformEnrollment();
  return (
    <button onClick={() => submitPasskeyCredential()}>
      Enroll Platform Authenticator
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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