MfaRecoveryCodeChallenge

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

mfa-recovery-code-challenge 画面では、他の MFA方式 が利用できない場合に、本人確認のため リカバリーコード の入力を求められます。

​

インポート

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

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

Import Example

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

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

function MfaRecoveryCodeChallengeScreen() {
  const { continueMethod } = useMfaRecoveryCodeChallenge();
  return (
    <button onClick={() => continueMethod({ code: 'XXXX XXXX XXXX XXXX' })}>
      Verify Recovery Code
    </button>
  );
}

​

Context Hooks

mfa-recovery-code-challenge 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面にスコープが設定されたHooksです。@auth0/auth0-acul-react/mfa-recovery-code-challenge からインポートします。

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

このHooksには、認証フロー内の現在の prompt に関するデータが含まれます。

Example

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

useScreen · () => ScreenMembers

このHooksには、設定やコンテキストなど、mfa-recovery-code-challenge 画面に固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

このHooksには、id や関連するメタデータなど、tenant に関連するデータが含まれます。

Example

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

useTransaction · () => TransactionMembers

このHooksは、現在のMFAフローの状態など、mfa-recovery-code-challenge 画面における transaction 固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaRecoveryCodeChallenge · MfaRecoveryCodeChallengeMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、MFAチャレンジを完了するために、ユーザーのリカバリーコードを送信します。

Example

import { useMfaRecoveryCodeChallenge } from '@auth0/auth0-acul-react/mfa-recovery-code-challenge';

function RecoveryCodeForm() {
  const { continueMethod } = useMfaRecoveryCodeChallenge();
  return (
    <button onClick={() => continueMethod({ code: 'XXXX XXXX XXXX XXXX' })}>
      Verify Recovery Code
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

MfaRecoveryCodeChallengeContinueOptions。

code · string · 必須

検証のためにユーザーが入力したリカバリーコード。

tryAnotherMethod · Promise<void>

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

Example

import { useMfaRecoveryCodeChallenge } from '@auth0/auth0-acul-react/mfa-recovery-code-challenge';

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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