サインアップ

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

signup 画面では、新しいアカウントの作成に必要なユーザーの資格情報を収集します。ユーザー名、メールアドレス、電話番号、パスワードを使用する通常のサインアップに加え、ソーシャル接続またはエンタープライズ接続、Google One Tap を使用したフェデレーションサインアップにも対応しています。

​

インポート

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

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

Import Example

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

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

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

​

コンテキストHooks

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パラメーター から渡されるユーザー名など、画面に渡される信頼できないデータを扱います。

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 画面で使用できるすべてのメソッドとコンテキストを返します。

​

メソッド

googleOneTap · Promise<void>

このメソッドは、Google One Tap 認証情報を使用して新しいユーザーを登録し、別のページにリダイレクトせずにワンクリックでサインアップできるようにします。

Example

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

function GoogleOneTapHandler({ credential }) {
  const { googleOneTap } = useSignup();
  return googleOneTap({ one_tap_credential: credential });
}

メソッドのパラメーター

表示 パラメーター

one_tap_credential · string · 必須

Google Identity Services のプロンプト から返される Google One Tap 認証情報トークン。

federatedSignup · Promise<void>

このメソッドは、サインアップのためにユーザーを Social または Enterprise Identity Provider (IdP) にリダイレクトします。

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

Social または Enterprise Identity Provider の接続名。

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

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

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

phoneNumber · string

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

captcha? · string

テナントでボット検出が有効になっている場合に必要な captcha 値。

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

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

usePasswordValidation · Hooks

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

useSignupIdentifiers · Hooks

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

useUsernameValidation · Hooks

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