SignupId

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

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

​

インポート

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

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

Import Example

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

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

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

​

コンテキストフック

signup-id 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。@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

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

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

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 画面のトランザクション固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

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

​

メソッド

federatedSignup · Promise<void>

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

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

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

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

メソッドパラメーター

表示 パラメーター

options

CustomOptions.

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

ulp- を接頭辞として持つ追加のカスタムフィールド (例: 'ulp-custom-field') 。

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

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

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

ulp- を接頭辞として持つ追加のカスタムフィールド (例: 'ulp-custom-field') 。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useSignupIdentifiers · Hooks

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

useUsernameValidation · Hooks

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