MfaWebauthnRoamingChallenge

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

mfa-webauthn-roaming-challenge 画面では、YubiKey などのローミング セキュリティ キーやその他の FIDO2 ハードウェア認証器を使用して、ユーザーに MFA チャレンジを完了するよう求めます。

​

インポート

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

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

Import Example

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

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

function MfaWebAuthnRoamingChallengeScreen() {
  const { verify } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Security Key
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaWebAuthnRoamingChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaWebAuthnRoamingChallenge · MfaWebAuthnRoamingChallengeMembers

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

​

メソッド

reportWebAuthnError · Promise<void>

このメソッドは、ローミング セキュリティ キーのチャレンジ中に発生した WebAuthn エラーを報告します。

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

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

メソッドのパラメーター

表示 パラメーター

options

MfaWebAuthnRoamingChallengeReportErrorOptions.

error · WebAuthnErrorDetails · 必須

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

name · string · 必須

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

message · string · 必須

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

tryAnotherMethod · Promise<void>

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

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

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

verify · Promise<void>

このメソッドは、MFA チャレンジを完了するためにローミング セキュリティ キーの検証を開始します。

Example

import { useMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/mfa-webauthn-roaming-challenge';

function VerifyButton() {
  const { verify } = useMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => verify({ rememberDevice: true })}>
      Verify with Security Key
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

VerifySecurityKeyOptions.

rememberDevice · boolean

任意。true の場合、今後の MFA チャレンジに備えてブラウザーを記憶することを試みます。 rememberBrowser form フィールドに対応します。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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