Skip to main content
The Signup class implements the signup screen functionality. This screen collects the user’s identifier and password. Depending on your tenant, this identifer 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 login screen.
​
organization
OrganizationMembers
Provides information about the user’s organization, such as organization 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 for the signup screen, 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

​
federatedSignup
(options ?)
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[]
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 (e.g., email, phone, username).
Example
const signup = new Signup();
const identifiers = signup.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]
​
pickCountryCode
(options ?)
This method redirects the user to the country code selection list, where they can update the country code prefix for their phone numnber.
Example
import Signup from "@auth0/auth0-acul-js/signup";
const signupManager = new Signup();

signupManager.pickCountryCode();
Method Parameters
​
signup
(options ?)
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.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
const signup = new Signup();
const result = signup.validateUsername('myusername');
// result => { valid: true, errors: [] }
Method Parameters