LoginPassword

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

login-password 画面は、識別子優先の認証フローの第 2 段階で、ユーザーがパスワードを入力する画面です。また、フェデレーションのアイデンティティプロバイダーや別の接続への切り替えにも対応しています。

​

インポート

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

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

Import Example

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

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

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

​

Context Hooks

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

useBranding · () => BrandingMembers

このHooksは、login-password 画面に表示されるロゴ、色、テーマ設定などのブランド設定を提供します。

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/login-password';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>組織コンテキストがありません</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginPassword

このHooksには、設定やコンテキストを含む login-password 画面固有の詳細情報が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnLoginPassword

このHooksは、アクティブな接続や現在のフローの状態など、login-password 画面に関するトランザクション固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLoginPassword · LoginPasswordMembers

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

​

メソッド

federatedLogin · Promise<void>

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

Example

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

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

メソッドパラメーター

表示 パラメーター

options

FederatedLoginPayloadOptions.

connection · string · 必須

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

login · Promise<void>

このメソッドは、login-password 画面での認証を完了するために、ユーザーの資格情報を送信します。

Example

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

function LoginPasswordForm() {
  const { login } = useLoginPassword();
  return (
    <button onClick={() => login({ username: '[e-mail]', password: 'secret' })}>
      サインイン
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

LoginPasswordOptions.

username · string · 必須

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

password · string · 必須

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

captcha? · string

テナントでボット検出が有効な場合に必要な Captcha 値。

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

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

switchConnection · Promise<void>

このメソッドは、フローをやり直すことなく、別の認証用接続に切り替えます。

Example

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

function ConnectionSwitcher() {
  const { switchConnection } = useLoginPassword();
  return (
    <button onClick={() => switchConnection({ connection: 'enterprise-saml' })}>
      SSO を使用
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

SwitchConnectionOptionsLoginPassword.

connection · string · 必須

切り替え先の接続名。パスワードレスの場合は ‘email’ または ‘sms’ を、パスワードベースの認証の場合は DB 接続名を使用します。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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