MfaRecoveryCodeEnrollment

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

mfa-recovery-code-enrollment 画面には、ユーザーが保存できるようにリカバリーコードが表示されます。このコードは、主要な MFA 手段にアクセスできなくなった場合にアカウントへアクセスするために使用できます。

​

インポート

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

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

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>
  );
}

​

コンテキストフック

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

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

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 フローの state など、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 · 必須

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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