SignupId

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

signup-id 画面では、複数ステップのサインアップフローの最初のステップとして、メールアドレス、ユーザー名、電話番号などの識別子をユーザーから収集します。また、ソーシャル接続またはエンタープライズ接続、Google One Tap を使用したフェデレーションサインアップにも対応しています。

​

インポート

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

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

Import Example

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

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

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: '[e-mail]' })}>
      Continue
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnSignupId

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnSignupId

このフックは、アクティブな接続や現在のフローの状態など、signup-id 画面に固有の transaction データを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useSignupId · SignupIdMembers

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

​

メソッド

googleOneTap · Promise<void>

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

Example

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

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

メソッドのパラメータ

表示 パラメータ

one_tap_credential · string · 必須

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

federatedSignup · Promise<void>

このメソッドは、サインアップのためにユーザーをソーシャルまたはエンタープライズ ID プロバイダー (IdP) にリダイレクトします。

Example

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

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

メソッドのパラメータ

表示 パラメータ

options

FederatedSignupOptions.

connection · string · 必須

ソーシャルまたはエンタープライズ ID プロバイダーの接続名。

pickCountryCode · Promise<void>

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

Example

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

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

signup · Promise<void>

このメソッドは、ユーザーの識別子を送信して、サインアップフローの次のステップに進みます。

Example

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

function SignupIdForm() {
  const { signup } = useSignupId();
  return (
    <button onClick={() => signup({ email: '[e-mail]' })}>
      Continue
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

SignupOptions.

email · string

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

username · string

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

phone · 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

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

useSignupIdentifiers · Hooks

このフックは、接続に設定されている Signup で利用可能な identifier types (email、ユーザー名、phone) を返します。

useUsernameValidation · Hooks

このフックは、テナントのユーザー名ポリシー要件に照らして、ユーザーのユーザー名を検証します。