MfaWebauthnError

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

mfa-webauthn-error 画面には、WebAuthn による認証の試行中に発生したエラーが表示され、ユーザーが復旧したり別の方法を試したりできるオプションが提供されます。

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useMfaWebAuthnError,
  // コンテキストHooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通Hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティHooks
  useChangeLanguage,
  // メソッド
  noThanks,
  tryAgain,
  tryAnotherMethod,
  usePassword,
} from "@auth0/auth0-acul-react/mfa-webauthn-error";

function MfaWebAuthnErrorScreen() {
  const { tryAgain } = useMfaWebAuthnError();
  return (
    <button onClick={() => tryAgain()}>
      Try Again
    </button>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-webauthn-error';
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-error';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaWebAuthnError

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaWebAuthnError · MfaWebAuthnErrorMembers

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

​

メソッド

noThanks · Promise<void>

このメソッドは WebAuthn エラーを閉じ、現在の MFA フローをキャンセルします。

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function NoThanksButton() {
  const { noThanks } = useMfaWebAuthnError();
  return (
    <button onClick={() => noThanks()}>
      No Thanks
    </button>
  );
}

tryAgain · Promise<void>

このメソッドは、エラー発生後に WebAuthn 認証を再試行します。

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function TryAgainButton() {
  const { tryAgain } = useMfaWebAuthnError();
  return (
    <button onClick={() => tryAgain()}>
      Try Again
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

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

usePassword · Promise<void>

このメソッドは、認証フローで WebAuthn の代わりにパスワードを使用するよう切り替えます。

Example

import { useMfaWebAuthnError } from '@auth0/auth0-acul-react/mfa-webauthn-error';

function UsePasswordButton() {
  const { usePassword } = useMfaWebAuthnError();
  return (
    <button onClick={() => usePassword()}>
      Use Password Instead
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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