MfaWebauthnRoamingEnrollment

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

mfa-webauthn-roaming-enrollment 画面では、YubiKey などのローミング セキュリティキーやその他の FIDO2 ハードウェア認証器を、MFA の認証要素としてユーザーに登録するよう求めます。

​

インポート

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

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

Import Example

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

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

function MfaWebAuthnRoamingEnrollmentScreen() {
  const { enroll } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => enroll()}>
      Enroll Security Key
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnRoamingEnrollment

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URL パラメーターから事前入力された値など、画面に渡される信頼できないデータを処理します。

Example

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

useUser · () => UserMembers

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

Example

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

useMfaWebAuthnRoamingEnrollment · MfaWebAuthnRoamingEnrollmentMembers

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

​

メソッド

enroll · Promise<void>

このメソッドは、ローミングセキュリティキーの登録プロセスを開始します。

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

function EnrollButton() {
  const { enroll } = useMfaWebAuthnRoamingEnrollment();
  return (
    <button onClick={() => enroll()}>
      Enroll Security Key
    </button>
  );
}

showError · Promise<void>

このメソッドは、セキュリティキーの登録中に発生した WebAuthn エラーを報告します。

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

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

メソッドパラメーター

表示 パラメーター

options

ShowErrorOptions。

error · WebAuthnErrorDetails · 必須

報告する WebAuthn API (navigator.credentials.create()) のエラーオブジェクト。

name · string · 必須

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

message · string · 必須

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

tryAnotherMethod · Promise<void>

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

Example

import { useMfaWebAuthnRoamingEnrollment } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-enrollment';

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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