EmailOtpChallenge - Auth0 Docs

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

インポート

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

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

Import Example

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

// 部分インポート
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>
  );
}

コンテキストフック

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>組織コンテキストがありません</p>;
  }
}

usePrompt

() => PromptMembers

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

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

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()}>
      Resend Code
    </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' })}>
      Continue
    </button>
  );
}