> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# LoginPassword
> Universal Login の `login-password` 画面をカスタマイズするために利用できるすべてのフックとメソッドについて説明します。
`login-password` 画面では、identifier-first 認証フローの第 2 段階として、ユーザーのパスワード入力を求めます。また、フェデレーション IDプロバイダーまたは別の接続への切り替えにも対応しています。
## インポート
各画面には、それぞれ固有のフックとメソッドが用意されています。SDK は、各画面で**部分インポート**と**ルートインポート**をサポートしています。
* 部分インポートを使用すると、特定のユースケースに必要なコードだけを取り込めます。
* ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めるため、考えられるすべての画面を 1 つのビルドで処理したい場合に便利です。
```jsx Import Example theme={null}
// ルートインポート
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 (
login({ username: 'user@example.com', password: 'secret' })}>
Sign In
);
}
```
## コンテキストフック
`login-password` 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。`@auth0/auth0-acul-react/login-password` からインポートします。
() => BrandingMembers }>
このフックは、`login-password` 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。
```jsx Example theme={null}
import { useBranding } from '@auth0/auth0-acul-react/login-password';
function CustomTheme() {
const branding = useBranding();
}
```
() => ClientMembers }>
このフックは、`login-password` 画面の `id`、`name`、`logoUrl` などのクライアント関連の設定を提供します。
```jsx Example theme={null}
import { useClient } from '@auth0/auth0-acul-react/login-password';
function AppInfo() {
const client = useClient();
}
```
() => OrganizationMembers }>
このフックは、ログインが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストがない場合は `null` を返します。
```jsx Example theme={null}
import { useOrganization } from '@auth0/auth0-acul-react/login-password';
function OrgSelector() {
const organization = useOrganization();
if (!organization) {
return No organization context
;
}
}
```
() => PromptMembers }>
このフックには、認証フローにおける現在のプロンプトに関するデータが含まれます。
```jsx Example theme={null}
import { usePrompt } from '@auth0/auth0-acul-react/login-password';
function FlowInfo() {
const prompt = usePrompt();
}
```
() => ScreenMembersOnLoginPassword }>
このフックには、設定やコンテキストを含む、`login-password` 画面固有の詳細が含まれます。
```jsx Example theme={null}
import { useScreen } from '@auth0/auth0-acul-react/login-password';
function ScreenDebug() {
const screen = useScreen();
}
```
() => TenantMembers }>
このフックには、`id` や関連するメタデータなど、テナントに関連するデータが含まれます。
```jsx Example theme={null}
import { useTenant } from '@auth0/auth0-acul-react/login-password';
function TenantInfo() {
const tenant = useTenant();
}
```
() => TransactionMembersOnLoginPassword }>
このフックは、アクティブな接続や現在のフロー state など、`login-password` 画面におけるトランザクション固有のデータを提供します。
```jsx Example theme={null}
import { useTransaction } from '@auth0/auth0-acul-react/login-password';
function TransactionInfo() {
const transaction = useTransaction();
}
```
() => UntrustedDataMembers }>
このフックは、URL パラメーターから事前入力された識別子など、画面に渡される信頼できないデータを扱います。
```jsx Example theme={null}
import { useUntrustedData } from '@auth0/auth0-acul-react/login-password';
function PrefilledForm() {
const untrustedData = useUntrustedData();
}
```
() => UserMembers }>
このフックは、`username`、`email`、利用可能な認証方法など、現在アクティブなユーザーの詳細を返します。
```jsx Example theme={null}
import { useUser } from '@auth0/auth0-acul-react/login-password';
function UserProfile() {
const user = useUser();
}
```
LoginPasswordMembers}>
このフックは、`login-password` 画面で利用できるすべてのメソッドとコンテキストを返します。
## メソッド
このメソッドは、Google や GitHub などのフェデレーション IDプロバイダーを使用した認証を開始します。
```jsx Example theme={null}
import { useLoginPassword } from '@auth0/auth0-acul-react/login-password';
function SocialButton() {
const { federatedLogin } = useLoginPassword();
return (
federatedLogin({ connection: 'google-oauth2' })}>
Sign in with Google
);
}
```
**メソッドパラメーター**
[FederatedLoginPayloadOptions](/ja/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions).
使用するソーシャル接続の名前 (例: `google-oauth2`、`github`) 。
このメソッドは、`login-password` 画面での認証を完了するために、ユーザーの認証情報を送信します。
```jsx Example theme={null}
import { useLoginPassword } from '@auth0/auth0-acul-react/login-password';
function LoginPasswordForm() {
const { login } = useLoginPassword();
return (
login({ username: 'user@example.com', password: 'secret' })}>
Sign In
);
}
```
**メソッドパラメーター**
[LoginPasswordOptions](/ja/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions).
認証に使用する識別子 (メールアドレス、電話番号、またはユーザー名) 。
認証に使用するパスワード。
テナントでボット検知が有効になっている場合に必要なキャプチャ値です。
`ulp-` プレフィックスが付いた追加のカスタムフィールド (例: `'ulp-custom-field'`) 。
このメソッドは、フローをやり直すことなく別の認証接続に切り替えます。
```jsx Example theme={null}
import { useLoginPassword } from '@auth0/auth0-acul-react/login-password';
function ConnectionSwitcher() {
const { switchConnection } = useLoginPassword();
return (
switchConnection({ connection: 'enterprise-saml' })}>
Use SSO
);
}
```
**メソッドパラメーター**
[SwitchConnectionOptionsLoginPassword](/ja/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/SwitchConnectionOptionsLoginPassword).
切り替え先の接続名です。パスワードレスの場合は `email` または `sms`、パスワードベースの認証の場合は DB 接続名を使用します。
`ulp-` プレフィックスが付いた追加のカスタムフィールド (例: `'ulp-custom-field'`) 。
## 共通/ユーティリティ Hooks
useAuth0Themes} type="Hooks">
このフックは、ブランディングコンテキストからフラット化された設定を含む現在のテーマオプションを取得します。
useChangeLanguage} type="Hooks">
このフックは、現在の ACUL 画面の表示言語を変更するための関数を返します。
useCurrentScreen} type="Hooks">
このフックは、現在の画面のコンテキストと state を取得します。
useErrors} type="Hooks">
このフックは、画面上のサーバー、クライアント、開発者のエラーを読み取り、管理します。
