MfaEmailChallenge

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

mfa-email-challenge 画面では、MFA 検証を完了するために、メールアドレスに送信されたワンタイムコードを入力するようユーザーに求めます。

​

インポート

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

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

Import Example

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

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

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

​

コンテキストフック

mfa-email-challenge 画面で Auth0 のコンテキストデータに読み取り専用でアクセスできる、画面スコープのフックです。@auth0/auth0-acul-react/mfa-email-challenge からインポートします。

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaEmailChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaEmailChallenge

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaEmailChallenge · MfaEmailChallengeMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、メール MFA チャレンジを完了するために、ユーザーが入力したワンタイムコードを送信します。

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function EmailChallengeForm() {
  const { continueMethod } = useMfaEmailChallenge();
  return (
    <button onClick={() => continueMethod({ code: '123456', rememberDevice: true })}>
      Verify
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ContinuePayloadOptions。

code · string · 必須

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

rememberDevice? · boolean

デバイスを記憶するかどうかを示します

pickEmail · Promise<void>

このメソッドは、チャレンジで複数のメールアドレスを利用できる場合に、メールアドレス選択画面へ移動します。

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function PickEmailButton() {
  const { pickEmail } = useMfaEmailChallenge();
  return (
    <button onClick={() => pickEmail()}>
      Use a Different Email
    </button>
  );
}

resendCode · Promise<void>

このメソッドは、新しいワンタイムコードをユーザーのメールアドレスに送信するよう要求します。

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

function ResendButton() {
  const { resendCode } = useMfaEmailChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useMfaEmailChallenge } from '@auth0/auth0-acul-react/mfa-email-challenge';

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

​

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

useResend · Hooks

このフックは、code の再送機能を備えた画面で、再送までのクールダウン状態とロジックを管理します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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