サインアップ

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

signup 画面では、新しいアカウントを作成するためにユーザーの認証情報を収集します。username、メールアドレス、電話番号、パスワードを使用する標準的なサインアップに加えて、ソーシャル接続またはエンタープライズ接続を介したフェデレーションサインアップにも対応しています。

​

インポート

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

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

Import Example

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

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

function SignupForm() {
  const { signup } = useSignup();
  return (
    <button onClick={() => signup({ email: '[e-mail]', password: 'secret' })}>
      Create Account
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnSignup

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnSignup

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URL パラメーターから事前入力されたメールアドレスや username など、画面に渡される信頼できないデータを扱います。

Example

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

useUser · () => UserMembers

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

Example

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

useSignup · SignupMembers

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

​

メソッド

federatedSignup · Promise<void>

このメソッドは、Google や GitHub などのフェデレーテッド IDプロバイダーを使用したサインアップを開始します。

Example

import { useSignup } from '@auth0/auth0-acul-react/signup';

function SocialButton() {
  const { federatedSignup } = useSignup();
  return (
    <button onClick={() => federatedSignup({ connection: 'google-oauth2' })}>
      Sign up with Google
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

FederatedSignupPayloadOptions.

connection · string · 必須

使用するソーシャル接続またはエンタープライズ接続の接続名 (例: google-oauth2、github) 。

pickCountryCode · Promise<void>

このメソッドは、サインアップ時に電話番号を入力するための国コードピッカーを開きます。

Example

import { useSignup } from '@auth0/auth0-acul-react/signup';

function CountryCodePicker() {
  const { pickCountryCode } = useSignup();
  return (
    <button onClick={() => pickCountryCode()}>
      Select Country Code
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

CustomOptions.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックス付きの追加のカスタムフィールド (例: 'ulp-custom-field') 。

signup · Promise<void>

このメソッドは、ユーザーの登録情報を送信して新しいアカウントを作成します。

Example

import { useSignup } from '@auth0/auth0-acul-react/signup';

function SignupForm() {
  const { signup } = useSignup();
  return (
    <button onClick={() => signup({ email: '[e-mail]', password: 'secret' })}>
      Create Account
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

SignupPayloadOptions.

email · string

ユーザーのメールアドレス。

password · string

新しいアカウントのパスワード。

username · string

接続で必要な場合に指定する、新しいアカウントの username。

phoneNumber · string

接続で必要な場合のユーザーの電話番号。

captcha? · string

テナントでボット検知が有効な場合に必要なキャプチャ値。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックス付きの追加のカスタムフィールド (例: 'ulp-custom-field') 。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

usePasswordValidation · Hooks

このフックは、ユーザーのパスワードがテナントのパスワードポリシー要件を満たしているか検証します。

useSignupIdentifiers · Hooks

このフックは、接続に設定されているサインアップで利用可能な識別子の種類 (メールアドレス、username、電話番号) を返します。

useUsernameValidation · Hooks

このフックは、ユーザーのusernameがテナントのusernameポリシー要件を満たしているか検証します。