Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The SignupPassword class implements the signup-password screen functionality. This screen collects the user’s password.
Signup Password with Flexible IDs

​
Constructors

Create an instance of SignupPassword screen manager:
Example
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.signup({
  email: 'test@example.com',
  password: 'P@$wOrd123!',
});

​
Properties

​
branding
BrandingMembers
Provides branding-related configurations, such as branding theme and settings.
​
client
ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the signup-password screen.
​
organization
OrganizationMembers
Provides information about the user’s Organization, such as id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembersOnSignupPassword
Contains details specific to the signup-password screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembersOnSignupPassword
Provides transaction-specific data, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during login.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
changeLanguage
Promise<void>
This method changes the display language of the Universal Login page.
Example
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
federatedSignup
Promise<void>
This method allows signup via different social identifiers. For example: Google, Facebook etc.
Example
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.federatedSignup({
  connection: 'google-oauth2',
});
Method Parameters
​
getErrors
Error[]
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.
​
signup
Promise<void>
This method handles the submission of the signup password form.
Example
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.signup({
  email: 'test@example.com',
  password: 'P@$wOrd123!',
});
Method Parameters
​
switchConnection
Promise<void>
This method switches the authentication connection during the signup-password flow.
Example
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
signupPasswordManager.switchConnection({
  connection: 'Username-Password-Authentication',
});
Method Parameters
​
validatePassword
PasswordValidationResult
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.
Example
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();
const result = signupPasswordManager.validatePassword('MyP@ssw0rd!');
Method Parameters