MfaEmailChallenge

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

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

​

インポート

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

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

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

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

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 や関連するメタデータなど、tenant に関連するデータが含まれます。

Example

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

useTransaction · () => TransactionMembers

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

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

このフックは、コード再送機能がある画面で、再送のクールダウン状態とロジックを管理します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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