EmailIdentifierChallenge

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

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

​

インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。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,
} from '@auth0/auth0-acul-react/email-identifier-challenge';

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

​

コンテキストフック

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

このフックは、メールチャレンジが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は 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

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

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

このフックは、アクティブな接続や現在のフロー状態など、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>

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

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

submitEmailChallenge · Promise<void>

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

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 · 必須

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

captcha? · string

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useResend · Hooks

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