> ## 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.
# SignupPassword
> Universal Login の `signup-password` 画面をカスタマイズするために使用できる、すべてのHooksとメソッドについて説明します。
`signup-password` 画面では、アカウント作成を完了するためにユーザーのパスワードを収集します。これは複数ステップのサインアップフローの第2ステップで、識別子の収集に続くものです。また、ソーシャルまたはエンタープライズ接続を介したフェデレーションによるサインアップにも対応しています。
## インポート
各画面には、それぞれ固有のHooksとメソッドがあります。SDK は、各画面について **partial import** と **root import** をサポートしています。
* partial import を使用すると、特定の用途に必要なコードだけを含めることができます。
* root import を使用すると、単一のバンドルからすべての画面を読み込めるため、想定されるすべての画面に対応する統一されたビルドが必要な場合に便利です。
```jsx Import Example theme={null}
// ルートインポート
import { useSignupPassword } from '@auth0/auth0-acul-react';
// 部分インポート
import {
useSignupPassword,
// コンテキストHooks
useUser,
useTenant,
useBranding,
useClient,
useOrganization,
usePrompt,
useScreen,
useTransaction,
useUntrustedData,
// 共通Hooks
useCurrentScreen,
useAuth0Themes,
useErrors,
// ユーティリティHooks
useChangeLanguage,
usePasswordValidation,
// メソッド
signup,
federatedSignup,
switchConnection,
} from '@auth0/auth0-acul-react/signup-password';
function SignupPasswordForm() {
const { signup } = useSignupPassword();
return (
signup({ password: 'secret' })}>
Create Account
);
}
```
## コンテキストHooks
`signup-password` 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面にスコープが設定されたHooksです。`@auth0/auth0-acul-react/signup-password` からインポートします。
() => BrandingMembers }>
このフックは、`signup-password` 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。
```jsx Example theme={null}
import { useBranding } from '@auth0/auth0-acul-react/signup-password';
function CustomTheme() {
const branding = useBranding();
}
```
() => ClientMembers }>
このフックは、`signup-password` 画面の `id`、`name`、`logoUrl` など、クライアント関連の設定を提供します。
```jsx Example theme={null}
import { useClient } from '@auth0/auth0-acul-react/signup-password';
function AppInfo() {
const client = useClient();
}
```
() => OrganizationMembers }>
このフックは、サインアップが組織にスコープされている場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は `null` を返します。
```jsx Example theme={null}
import { useOrganization } from '@auth0/auth0-acul-react/signup-password';
function OrgSelector() {
const organization = useOrganization();
if (!organization) {
return No organization context
;
}
}
```
() => PromptMembers }>
このフックには、認証フローにおける現在の prompt に関するデータが含まれています。
```jsx Example theme={null}
import { usePrompt } from '@auth0/auth0-acul-react/signup-password';
function FlowInfo() {
const prompt = usePrompt();
}
```
() => ScreenMembersOnSignupPassword }>
このフックには、設定やコンテキストなど、`signup-password` 画面に固有の詳細情報が含まれています。
```jsx Example theme={null}
import { useScreen } from '@auth0/auth0-acul-react/signup-password';
function ScreenDebug() {
const screen = useScreen();
}
```
() => TenantMembers }>
このフックには、`id` や関連するメタデータなど、テナントに関するデータが含まれています。
```jsx Example theme={null}
import { useTenant } from '@auth0/auth0-acul-react/signup-password';
function TenantInfo() {
const tenant = useTenant();
}
```
() => TransactionMembersOnSignupPassword }>
このフックは、アクティブな接続や現在のフローの状態など、`signup-password` 画面に固有のトランザクションデータを提供します。
```jsx Example theme={null}
import { useTransaction } from '@auth0/auth0-acul-react/signup-password';
function TransactionInfo() {
const transaction = useTransaction();
}
```
() => UntrustedDataMembers }>
このフックは、事前入力されたメールアドレスや URLパラメーター から渡されるユーザー名など、画面に渡された信頼できないデータを扱います。
```jsx Example theme={null}
import { useUntrustedData } from '@auth0/auth0-acul-react/signup-password';
function PrefilledForm() {
const untrustedData = useUntrustedData();
}
```
() => UserMembers }>
このフックでは、`username`、`email`、利用可能な認証方法など、現在のユーザーの詳細を取得できます。
```jsx Example theme={null}
import { useUser } from '@auth0/auth0-acul-react/signup-password';
function UserProfile() {
const user = useUser();
}
```
SignupPasswordMembers}>
このフックは、`signup-password` 画面で利用可能なすべてのメソッドとコンテキストを返します。
## メソッド
このメソッドは、サインアップのためにユーザーを [Social](/docs/ja-jp/authenticate/identity-providers/social-identity-providers) または [Enterprise Identity Provider](/docs/ja-jp/authenticate/identity-providers/enterprise-identity-providers) (IdP) にリダイレクトします。
```jsx Example theme={null}
import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';
function SocialButton() {
const { federatedSignup } = useSignupPassword();
return (
federatedSignup({ connection: 'google-oauth2' })}>
Sign up with Google
);
}
```
**メソッドのパラメータ**
[FederatedSignupPasswordPayloadOptions](/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions).
Social または Enterprise Identity Provider の接続名。
このメソッドは、アカウント作成を完了するためにユーザーのパスワードを送信します。
```jsx Example theme={null}
import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';
function SignupPasswordForm() {
const { signup } = useSignupPassword();
return (
signup({ password: 'secret' })}>
Create Account
);
}
```
**メソッドのパラメータ**
[SignupPasswordOptions](/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions).
新しいアカウントのパスワード。
ユーザーのメールアドレス。
接続で必要な場合に使用する、新しいアカウントのユーザー名。
接続で必要な場合の、ユーザーの電話番号。
テナントでボット検出が有効になっている場合に必要な captcha 値。
`ulp-` で始まる追加のカスタムフィールド (例: `'ulp-custom-field'`) 。
このメソッドは、signup-password ステップ中にアクティブな接続を切り替え、ユーザーが別の接続で認証できるようにします。
```jsx Example theme={null}
import { useSignupPassword } from '@auth0/auth0-acul-react/signup-password';
function SwitchConnection() {
const { switchConnection } = useSignupPassword();
return (
switchConnection({ connection: 'Username-Password-Authentication' })}>
Use a different method
);
}
```
**メソッドのパラメータ**
[SwitchConnectionOptionsSignupPassword](/docs/ja-jp/libraries/acul/react-sdk/API-Reference/Types/interfaces/SwitchConnectionOptionsSignupPassword).
切り替え先の接続名。パスワードレスには `email` または `sms` を使用し、パスワードベース認証には DB 接続名を使用します。
`ulp-` で始まる追加のカスタムフィールド (例: `'ulp-custom-field'`) 。
## 共通/Utility Hooks
useAuth0Themes} type="Hooks">
このフックは、ブランディングコンテキストからフラット化された設定を含む現在のテーマオプションを取得します。
useChangeLanguage} type="Hooks">
このフックは、現在のACUL画面で表示言語を変更するための関数を返します。
useCurrentScreen} type="Hooks">
このフックは、現在の画面のコンテキストと状態を取得します。
useErrors} type="Hooks">
このフックは、画面上のサーバー、クライアント、および開発者のエラーを読み取って管理します。
usePasswordValidation} type="Hooks">
このフックは、ユーザーのパスワードがテナントのパスワードポリシー要件を満たしているかどうかを検証します。
