> ## Documentation Index
> Fetch the complete documentation index at: https://auth0.generaltranslation.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SignupPassword

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

```ts Example theme={null}
import SignupPassword from "@auth0/auth0-acul-js/signup-password";
const signupPasswordManager = new SignupPassword();
const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!');
console.log(validationResults);
// [
//   { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false },
//   { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true },
//   ...
// ]
```

## Constructors

<ParamField body="SignupPassword" type="Constructor" />

## Properties

<ParamField body="branding" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>} />

<ParamField body="client" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>} />

<ParamField body="organization" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>} />

<ParamField body="prompt" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>} />

<ParamField body="screen" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword">ScreenMembersOnSignupPassword</a></span>} />

<ParamField body="tenant" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>} />

<ParamField body="transaction" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword">TransactionMembersOnSignupPassword</a></span>} />

<ParamField body="untrustedData" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>} />

<ParamField body="user" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>} />

<ParamField body="screenIdentifier" type="string" />

## Methods

<ParamField body="federatedSignup" type="Promise<void>">
  #### Remarks

  This methods handles allows signup via different social identifiers.
  Eg: Google, Facebook etc.

  ```ts Example theme={null}
  import SignupPassword from "@auth0/auth0-acul-js/signup-id";

  const signupIdManager = new SignupPassword();
  const { transaction } = signupIdManager;

  //get social connections
  const socialConnection = transaction.alternateConnections; //eg: "google-oauth2"

  const signupParams = {
   connection : socialConnection[0].name, // "google-oauth2"
  };

  signupIdManager.federatedSignup(signupParams);
  ```

  <Expandable title="Parameters">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions">FederatedSignupPasswordPayloadOptions</a></span>}>
      **Properties**

      <ParamField body="connection" type="string" />
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="getErrors" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
  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>">
  #### Remarks

  This methods handles signup-password related screen configuration.
  It allows to proceed with registering signup password along with signup identifiers passed in previous screen

  ```ts Example theme={null}
  import SignupPassword from "@auth0/auth0-acul-js/signup-password";

  const signupPasswordManager = new SignupPassword();
  const { transaction, screen } = signupPasswordManager;

  //get mandatory & optional identifiers required for signup-password screen to proceed
  const mandatoryIdentifier = transaction.getRequiredIdentifiers(); //eg: email
  const optionalIdentifiers = transaction.getOptionalIdentifiers() //eg: phone

  //get signup data submitted on previous screen from previous screen
  const data = transaction.screen.getScreenData(); //eg: email, phone

  const signupParams = {
   email : data.email,
   password: "******"
  };

  signupPasswordManager.signup(signupParams);
  ```

  <Expandable title="Parameters">
    <ParamField body="payload" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/SignupPasswordOptions">SignupPasswordOptions</a></span>}>
      **Properties**

      <ParamField body="captcha?" type="string" />

      <ParamField body="email?" type="string" />

      <ParamField body="password" type="string" />

      <ParamField body="phoneNumber?" type="string" />

      <ParamField body="username?" type="string" />
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="validatePassword" type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PasswordValidationResult">PasswordValidationResult</a></span>}>
  **`Utility Feature`**

  Validates a password string against the current transaction's password policy.

  This method retrieves the password policy from the current transaction context
  and delegates the actual validation to `coreValidatePassword`.

  It returns an array of validation results, each containing:

  * `code`: the identifier of the password rule,
  * `policy`: a user-friendly description of the rule,
  * `isValid`: boolean indicating if the password passed that rule.

  ```ts Example theme={null}
  import SignupPassword from "@auth0/auth0-acul-js/signup-password";
  const signupPasswordManager = new SignupPassword();
  const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!');
  console.log(validationResults);
  // [
  //   { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false },
  //   { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true },
  //   ...
  // ]
  ```

  <Expandable title="Parameters">
    <ParamField body="password" type="string">
      `string`

      The password string to validate.
    </ParamField>
  </Expandable>
</ParamField>
