LoginId

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

login-id 画面では、identifier-first 認証フローの最初のステップとして、ユーザーの識別子を収集します。テナントによっては、この識別子としてメールアドレス、電話番号、または username を使用できます。また、パスキーによるログインやフェデレーション IDプロバイダーにも対応しています。

​

インポート

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

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

Import Example

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

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

function LoginIdForm() {
  const { login } = useLoginId();
  return (
    <button onClick={() => login({ username: '[e-mail]' })}>
      Continue
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、login-id 画面で使用される id、name、logoUrl などのクライアント関連の構成を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginId

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnLoginId

このフックは、アクティブな接続、利用可能なログイン方法、現在のフロー状態など、login-id 画面のトランザクション固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLoginId · LoginIdMembers

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

​

メソッド

federatedLogin · Promise<void>

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

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

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

メソッドパラメーター

表示 パラメーター

options

FederatedLoginPayloadOptions。

connection · string · 必須

使用するソーシャル接続の名前 (例: google-oauth2、github) 。

login · Promise<void>

このメソッドは、認証フローの次のステップに進むため、ユーザーの識別子を送信します。

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

function LoginIdForm() {
  const { login } = useLoginId();
  return (
    <button onClick={() => login({ username: '[e-mail]' })}>
      Continue
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

LoginOptions。

username · string · 必須

認証に使用する識別子 (メールアドレス、電話番号、または username) 。

captcha? · string

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

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

ulp- で始まる追加のカスタムフィールド (例: 'ulp-custom-field') 。

passkeyLogin · Promise<void>

このメソッドは、パスキーを使用したパスワードレス認証を開始します。

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

function PasskeyButton() {
  const { passkeyLogin } = useLoginId();
  return (
    <button onClick={() => passkeyLogin()}>
      Sign in with Passkey
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

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

ulp- で始まる追加のカスタムフィールド (例: 'ulp-custom-field') 。

pickCountryCode · Promise<void>

このメソッドは、電話番号ベースのログインフローで国番号ピッカーに移動します。

Example

import { useLoginId } from '@auth0/auth0-acul-react/login-id';

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

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

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

ulp- で始まる追加のカスタムフィールド (例: 'ulp-custom-field') 。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者の各エラーを参照および管理します。

useLoginIdentifiers · Hooks

このフックは、現在のフローで有効な識別子タイプ (email、phone、username) の一覧を返します。

usePasskeyAutofill · Hooks

このフックは、シームレスなパスワードレスログインを実現するため、入力フィールドでパスキーの自動入力を有効にします。