Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0-feat-authentication-api-migration.mintlify.app/llms.txt

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

The Signup class implements the signup screen functionality. This screen collects the user’s identifier and password. Depending on your tenant, this identifier can be an email, phone number, or username.
ACUL Signup screen image

​
Constructors

Create an instance of Signup screen manager:
Example
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.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 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
ScreenMembersOnSignup
Contains details specific to the signup screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembersOnSignup
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 Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
federatedSignup
Promise<void>
This method handles the submission of the social signup form. It is similar to the signup method but is used for social signups.
Example
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.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.
​
getSignupIdentifiers
Identifier[] | null
This method returns the list of enabled identifiers for the signup form, marking each as required or optional based on transaction config. An array of identifier objects (for example, email, phone, username).
Example
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const identifiers = signupManager.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]
​
pickCountryCode
Promise<void>
This method redirects the user to the country code selection list, where they can update the country code prefix for their phone number.
Example
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.pickCountryCode();
​
signup
Promise<void>
This method handles the submission of the signup form.
Example
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
signupManager.signup({
  email: 'test@example.com',
  password: 'P@$wOrd123!',
});
Method Parameters
​
validatePassword
PasswordValidationResult
This method returns an object of type PasswordValidationResult indicating whether the password is valid and why.
Example
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validatePassword('P@$wOrd123!');
Method Parameters
​
validateUsername
UsernameValidationResult
This method validates a given username against the current username policy defined in the transaction context. It returns an object indicating whether the username is valid and why.
Example
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();
const result = signupManager.validateUsername('myusername');
// result => { valid: true, errors: [] }
Method Parameters