MfaOtpEnrollmentCode

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

mfa-otp-enrollment-code 画面では、認証アプリでの OTP の登録を完了するために、ユーザーに確認コードの入力を求めます。

​

インポート

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

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

Import Example

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

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

function MfaOtpEnrollmentCodeScreen() {
  const { continueMethod } = useMfaOtpEnrollmentCode();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaOtpEnrollmentCode

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、現在の MFA フローの state など、mfa-otp-enrollment-code 画面に関する transaction 固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaOtpEnrollmentCode · MfaOtpEnrollmentCodeMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、ユーザーが入力したOTPコードを送信して登録を完了します。

Example

import { useMfaOtpEnrollmentCode } from '@auth0/auth0-acul-react/mfa-otp-enrollment-code';

function EnrollmentCodeForm() {
  const { continueMethod } = useMfaOtpEnrollmentCode();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

MfaOtpContinueOptions。

code · string · 必須

ユーザーが入力したOTPコード。

toggleView · Promise<void>

このメソッドは、mfa-otp-enrollment-code 画面の表示を切り替えます。たとえば、QRコード表示と手動入力表示を切り替えます。

Example

import { useMfaOtpEnrollmentCode } from '@auth0/auth0-acul-react/mfa-otp-enrollment-code';

function ToggleViewButton() {
  const { toggleView } = useMfaOtpEnrollmentCode();
  return (
    <button onClick={() => toggleView()}>
      Switch View
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaOtpEnrollmentCode } from '@auth0/auth0-acul-react/mfa-otp-enrollment-code';

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

​

共通/Utility Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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