EmailIdentifierChallenge

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

email-identifier-challenge 画面は、ユーザーがメールアドレスに送信されたコードを入力して本人確認を行う必要がある場合に表示されます。ユーザーはコードを入力したり、再送したり、前のステップに戻ったりできます。

​

インポート

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

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

Import Example

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

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

function EmailIdentifierChallengeScreen() {
  const { submitEmailChallenge } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => submitEmailChallenge({ code: '123456' })}>Submit</button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnEmailIdentifierChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフロー state など、email-identifier-challenge 画面に関するトランザクション固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

このフックは、現在のユーザーに関する情報 (username、email、利用可能な認証方法など) を提供します。

Example

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

useEmailIdentifierChallenge · EmailIdentifierChallengeMembers

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

​

メソッド

resendCode · Promise<void>

このメソッドは、ユーザーのメールアドレスに確認コードを再送します。

Example

import { useEmailIdentifierChallenge } from '@auth0/auth0-acul-react/email-identifier-challenge';

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

returnToPrevious · Promise<void>

このメソッドは、ユーザーを認証フローの前のステップに戻します。

Example

import { useEmailIdentifierChallenge } from '@auth0/auth0-acul-react/email-identifier-challenge';

function BackButton() {
  const { returnToPrevious } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => returnToPrevious()}>
      Back
    </button>
  );
}

switchToPassword · Promise<void>

認証フローをメール OTP による確認からパスワードベースの認証に切り替えます。

Example

import { useEmailIdentifierChallenge } from '@auth0/auth0-acul-react/email-identifier-challenge';

function SwitchToPasswordButton() {
  const { switchToPassword } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => switchToPassword()}>
      Use password instead
    </button>
  );
}

submitEmailChallenge · Promise<void>

このメソッドは、ユーザーが入力したメール確認コードを送信します。

Example

import { useEmailIdentifierChallenge } from '@auth0/auth0-acul-react/email-identifier-challenge';

function SubmitButton() {
  const { submitEmailChallenge } = useEmailIdentifierChallenge();
  return (
    <button onClick={() => submitEmailChallenge({ code: '123456' })}>
      Continue
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

EmailChallengeOptions。

code · string · 必須

ユーザーのメールアドレスに送信された確認コード。

captcha? · string

このテナントで CAPTCHA が有効な場合の CAPTCHA 応答トークン。

​

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

useAuth0Themes · フック

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

useChangeLanguage · フック

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

useCurrentScreen · フック

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

useErrors · フック

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

useResend · フック

このフックは、メール確認コードの再送stateとクールダウンロジックを管理します。