ログイン

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

login 画面では、ユーザーの識別子とパスワードを入力します。テナントの設定によっては、この識別子としてメールアドレス、電話番号、または username を使用できます。また、フェデレーテッド IDプロバイダーを使用した認証にも対応しています。

​

インポート

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

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

Import Example

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

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

function LoginForm() {
  const { login, federatedLogin } = useLogin();
  return (
    <button onClick={() => login({ username: "[e-mail]", password: "secret" })}>
      Sign In
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnLogin

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnLogin

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLogin · LoginMembers

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

​

メソッド

federatedLogin · Promise<void>

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

Example

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

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

メソッドパラメーター

表示 パラメーター

options

FederatedLoginPayloadOptions。

connection · string · 必須

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

login · Promise<void>

このメソッドは、ユーザーの認証情報を送信して、login 画面での認証を完了します。

Example

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

function LoginForm() {
  const { login } = useLogin();
  return (
    <button onClick={() => login({ username: '[e-mail]', password: 'secret' })}>
      Sign In
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

LoginPayloadOptions。

username · string · 必須

認証に使用する username またはメールアドレス。

password · string · 必須

認証に使用するパスワード。

captcha? · string

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

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

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

pickCountryCode · Promise<void>

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

Example

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

function PhoneLogin() {
  const { pickCountryCode } = useLogin();
  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) のリストを返します。