MfaRecoveryCodeEnrollment

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

mfa-recovery-code-enrollment 画面には、ユーザーが保存できるリカバリーコードが表示されます。これは、メインの MFA方式 を利用できなくなった場合に、アカウントにアクセスするために使用できます。

​

インポート

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

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

Import Example

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

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

function MfaRecoveryCodeEnrollmentScreen() {
  const { continueMethod } = useMfaRecoveryCodeEnrollment();
  return (
    <button onClick={() => continueMethod({ isCodeCopied: true })}>
      I've Saved My Recovery Code
    </button>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaRecoveryCodeEnrollment

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaRecoveryCodeEnrollment · MfaRecoveryCodeEnrollmentMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、ユーザーがリカバリーコードを保存したことを確認し、登録フローを続行します。

Example

import { useMfaRecoveryCodeEnrollment } from '@auth0/auth0-acul-react/mfa-recovery-code-enrollment';

function ContinueButton() {
  const { continueMethod } = useMfaRecoveryCodeEnrollment();
  return (
    <button onClick={() => continueMethod({ isCodeCopied: true })}>
      I've Saved My Recovery Code
    </button>
  );
}

メソッド パラメーター

表示 パラメーター

options

MfaRecoveryCodeEnrollmentContinueOptions。

isCodeCopied · boolean · 必須

ユーザーがリカバリーコードをコピーまたは保存したかどうかを示します。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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