> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev-docs-event-stream-action-templates.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SignupPassword

> Describes all the properties and methods available to customize the Universal Login `signup-password` screen.

The SignupPassword class implements the `signup-password` screen functionality. This screen collects the user's password.

<Frame>
  <img style={{maxHeight:"400px"}} src="https://mintcdn.com/docs-dev-docs-event-stream-action-templates/tcenw4jcNpftRqWN/docs/images/cdy7uua7fh8z/5h85r3sVhe8mVw7rDkDwTD/02c3521d9d6c4d490c1a64ae37ecca72/Signup_Password_with_Flexible_IDs.png?fit=max&auto=format&n=tcenw4jcNpftRqWN&q=85&s=6e72c03a1a2d2002fc8fc16e1cd0f961" alt="Signup Password with Flexible IDs" width="480" height="1032" data-path="docs/images/cdy7uua7fh8z/5h85r3sVhe8mVw7rDkDwTD/02c3521d9d6c4d490c1a64ae37ecca72/Signup_Password_with_Flexible_IDs.png" />
</Frame>

## Constructors

Create an instance of SignupPassword screen manager:

```typescript Example theme={null}
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.signup({
  email: 'test@example.com',
  password: 'P@$wOrd123!',
});
```

## Properties

<ParamField body="branding" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
  Provides branding-related configurations, such as branding theme and settings.
</ParamField>

<ParamField body="client" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
  Provides client-related configurations, such as `id`, `name`, and `logoUrl`, for the `signup-password` screen.
</ParamField>

<ParamField body="organization" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
  Provides information about the user's Organization, such as `id` and `name`.
</ParamField>

<ParamField body="prompt" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}>
  Contains data about the current prompt in the authentication flow.
</ParamField>

<ParamField body="screen" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>}>
  Contains details specific to the `signup-password` screen, including its configuration and context.
</ParamField>

<ParamField body="tenant" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}>
  Contains data related to the tenant, such as `id` and associated metadata.
</ParamField>

<ParamField body="transaction" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>}>
  Provides transaction-specific data, such as active identifiers and flow states.
</ParamField>

<ParamField body="untrustedData" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
  Handles untrusted data passed to the SDK, such as user input during login.
</ParamField>

<ParamField body="user" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}>
  Details of the active user, including `username`, `email`, and `roles`.
</ParamField>

## Methods

<ParamField body="changeLanguage" type="Promise<void>">
  This method changes the display language of the Universal Login page.

  ```typescript Example theme={null}
  import SignupPassword from '@auth0/auth0-acul-js/signup-password';
  const signupPasswordManager = new SignupPassword();
  signupPasswordManager.changeLanguage({
    language: 'fr',
  });
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [LanguageChangeOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/LanguageChangeOptions).
    </ParamField>

    <ParamField body="language" type="string" required>
      The locale code for the desired language (for example, `'en'`, `'fr'`, `'es'`).
    </ParamField>

    <ParamField body="persist?" type="&#x22;session&#x22;">
      When set to `'session'`, the selected language persists for the duration of the session.
    </ParamField>

    <ParamField body="[`key`: `string`]" type="&#x22;string&#x22; | &#x22;number&#x22; | &#x22;boolean&#x22; | &#x22;undefined&#x22;">
      Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="federatedSignup" type="Promise<void>">
  This method allows signup via different social identifiers. For example: Google, Facebook etc.

  ```typescript Example theme={null}
  import SignupPassword from '@auth0/auth0-acul-js/signup-password';
  const signupPasswordManager = new SignupPassword();
  signupPasswordManager.federatedSignup({
    connection: 'google-oauth2',
  });
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [FederatedSignupPasswordPayloadOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions).
    </ParamField>

    <ParamField body="connection" type="string" required>
      The social connection name to use.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="getErrors" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
  This method retrieves the array of transaction errors from the context, or an empty array if none exist. An array of error objects from the transaction context.
</ParamField>

<ParamField body="signup" type="Promise<void>">
  This method handles the submission of the signup password form.

  ```typescript Example theme={null}
  import SignupPassword from '@auth0/auth0-acul-js/signup-password';
  const signupPasswordManager = new SignupPassword();
  signupPasswordManager.signup({
    email: 'test@example.com',
    password: 'P@$wOrd123!',
  });
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [SignupPasswordOptions](/docs/libraries/acul/js-sdk/Screens/interfaces/SignupPasswordOptions).
    </ParamField>

    <ParamField body="email?" type="string">
      The user's email.
    </ParamField>

    <ParamField body="username?" type="string">
      The user's identifier.
    </ParamField>

    <ParamField body="phoneNumber?" type="string">
      The user's phone number.
    </ParamField>

    <ParamField body="password" type="string" required>
      The user's password.
    </ParamField>

    <ParamField body="captcha?" type="string">
      The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has [Bot Detection](/docs/secure/attack-protection/bot-detection) enabled.
    </ParamField>

    <ParamField body="[`key`: `string`]" type="&#x22;string&#x22; | &#x22;number&#x22; | &#x22;boolean&#x22; | &#x22;undefined&#x22;">
      Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="switchConnection" type="Promise<void>">
  This method switches the authentication connection during the signup-password flow.

  ```typescript Example theme={null}
  import SignupPassword from '@auth0/auth0-acul-js/signup-password';
  const signupPasswordManager = new SignupPassword();
  signupPasswordManager.switchConnection({
    connection: 'Username-Password-Authentication',
  });
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="options">
      [SwitchConnectionOptionsSignupPassword](/docs/libraries/acul/js-sdk/Screens/interfaces/SwitchConnectionOptionsSignupPassword).
    </ParamField>

    <ParamField body="connection" type="string" required>
      The connection identifier to switch to during the signup-password authentication flow.
    </ParamField>

    <ParamField body="[`key`: `string`]" type="&#x22;string&#x22; | &#x22;number&#x22; | &#x22;boolean&#x22;">
      Additional custom fields prefixed with `ulp-` (for example, `'ulp-custom-field'`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="validatePassword" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}>
  This method validates a password string against the current transaction's password policy. It returns an object indicating whether the password is valid and why.

  ```typescript Example theme={null}
  import SignupPassword from '@auth0/auth0-acul-js/signup-password';
  const signupPasswordManager = new SignupPassword();
  const result = signupPasswordManager.validatePassword('MyP@ssw0rd!');
  ```

  **Method Parameters**

  <Expandable title="Parameters">
    <ParamField body="password" type="string" required>
      The password string to validate.
    </ParamField>
  </Expandable>
</ParamField>
