MfaWebauthnRoamingEnrollment

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

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

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useMfaWebAuthnRoamingEnrollment,
  // コンテキスト Hooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通 Hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティ Hooks
  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>
  );
}

​

コンテキスト Hooks

mfa-webauthn-roaming-enrollment 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープの Hooks です。@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 フローが Organization スコープの場合に、ユーザーの組織に関する情報を提供します。Organization コンテキストが存在しない場合は 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()) から返されたerror object。

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>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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