EmailOtpChallenge

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

email-otp-challenge 画面は、ユーザーがメールアドレスに送信されたワンタイムパスコードを入力して本人確認を行う必要がある場合に表示されます。ユーザーはコードを入力して送信することも、再送信することもできます。

​

インポート

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

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

Import Example

// root import
import { useEmailOTPChallenge } from '@auth0/auth0-acul-react';

// partial import
import {
  useEmailOTPChallenge,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  submitCode,
  resendCode,
} from '@auth0/auth0-acul-react/email-otp-challenge';

function EmailOtpChallengeScreen() {
  const { submitCode } = useEmailOTPChallenge();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>Submit</button>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnEmailOTPChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useEmailOTPChallenge · EmailOTPChallengeMembers

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

​

メソッド

resendCode · Promise<void>

このメソッドは、ワンタイムパスコードをユーザーのメールアドレスに再送信します。

Example

import { useEmailOTPChallenge } from '@auth0/auth0-acul-react/email-otp-challenge';

function ResendButton() {
  const { resendCode } = useEmailOTPChallenge();
  return (
    <button onClick={() => resendCode()}>
      コードを再送
    </button>
  );
}

submitCode · Promise<void>

このメソッドは、ユーザーが入力したワンタイムパスコードを送信します。

Example

import { useEmailOTPChallenge } from '@auth0/auth0-acul-react/email-otp-challenge';

function SubmitButton() {
  const { submitCode } = useEmailOTPChallenge();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      続行
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

OtpCodeOptions。

code · string · 必須

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useResend · Hooks

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