確認

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

confirmation 画面は、Auth0 が自動サインアップの対象となる可能性を検出した場合、OTP の検証後に表示されます。ユーザーはここでアカウントを作成するかどうかを確認できます。

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useConfirmation,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  proceedToSignup,
  goBack,
} from '@auth0/auth0-acul-react/confirmation';

function ConfirmationScreen() {
  const { proceedToSignup } = useConfirmation();
  return (
    <button onClick={() => proceedToSignup()}>
      Create Account
    </button>
  );
}

​

コンテキストフック

confirmation画面で、Auth0のコンテキストデータに読み取り専用でアクセスするための画面スコープのフックです。@auth0/auth0-acul-react/confirmationからインポートします。

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、confirmation画面のid、name、logoUrlなど、クライアントに関する設定を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/confirmation';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/confirmation';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

このフックには、設定やコンテキストなど、confirmation画面固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、有効な識別子やフローの状態など、confirmation画面に固有のトランザクションデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URLパラメーターで事前入力されたフィールドなど、画面に渡される信頼されていないデータを処理します。

Example

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

useUser · () => UserMembers

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

Example

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

useConfirmation · ConfirmationMembers

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

​

メソッド

proceedToSignup · Promise<void>

このメソッドは自動サインアップを確定し、OTPの検証後にアカウント作成に進みます。

Example

import { useConfirmation } from '@auth0/auth0-acul-react/confirmation';

function ConfirmButton() {
  const { proceedToSignup } = useConfirmation();
  return (
    <button onClick={() => proceedToSignup()}>
      アカウントを作成
    </button>
  );
}

goBack · Promise<void>

このメソッドは自動サインアップをキャンセルし、アカウントを作成せずにユーザーをログイン画面に戻します。

Example

import { useConfirmation } from '@auth0/auth0-acul-react/confirmation';

function CancelButton() {
  const { goBack } = useConfirmation();
  return (
    <button onClick={() => goBack()}>
      戻る
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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