LoginId

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

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

​

インポート

各画面には、それぞれ独自のフックとメソッドがあります。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,
  googleOneTap,
  passkeyLogin,
  pickCountryCode,
} from '@auth0/auth0-acul-react/login-id';

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

​

Context Hooks

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

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

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

​

メソッド

googleOneTap · Promise<void>

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

Example

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

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

メソッドパラメーター

表示 パラメーター

one_tap_credential · string · 必須

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

federatedLogin · Promise<void>

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

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

メソッドパラメーター

表示 パラメーター

connection · string · 必須

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

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

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

captcha? · string

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

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useLoginIdentifiers · Hooks

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

usePasskeyAutofill · Hooks

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