LoginPassword

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

login-password 画面では、identifier-first 認証フローの第 2 段階として、ユーザーのパスワード入力を求めます。また、フェデレーション IDプロバイダーまたは別の接続への切り替えにも対応しています。

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useLoginPassword,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  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>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginPassword

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnLoginPassword

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、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>

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

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

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

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' })}>
      Sign In
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

LoginPasswordOptions.

username · string · 必須

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

password · string · 必須

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

captcha? · string

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

[`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' })}>
      Use SSO
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

SwitchConnectionOptionsLoginPassword.

connection · string · 必須

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

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

ulp- プレフィックスが付いた追加のカスタムフィールド (例: 'ulp-custom-field') 。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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