MfaWebauthnRoamingChallenge

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

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

​

インポート

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

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

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 })}>
      セキュリティキーで検証
    </button>
  );
}

​

Context Hooks

mfa-webauthn-roaming-challenge 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。@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>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

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

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 フローの状態など、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 })}>
      エラーを報告
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

MfaWebAuthnRoamingChallengeReportErrorOptions.

error · WebAuthnErrorDetails · 必須

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

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()}>
      別の方法を試す
    </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 })}>
      セキュリティキーで検証
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

VerifySecurityKeyOptions.

rememberDevice · boolean

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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