Skip to main content
The SignupId class implements the signup-id screen functionality. This screen collects the user’s identifier — such as email, username, or phone number — as the first step of a multi-step signup flow. It also supports federated signup via social or enterprise connections and Google One Tap.
Signup ID

​
Constructors

Create an instance of SignupId screen manager:
Example
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
  email: 'test@example.com',
});

​
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-id 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
ScreenMembersOnSignupId
Contains details specific to the signup-id screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembersOnSignupId
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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
federatedSignup
Promise<void>
This method redirects the user to the Social or Enterprise Identity Provider (IdP) for signup.
Example
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.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-id form, marking each as required or optional based on transaction config. An array of identifier objects (for example: email, phone, username).
Example
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
const identifiers = signupIdManager.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]
​
googleOneTap
Promise<void>
This method registers a new user using a Google One Tap credential, enabling one-click sign-up without redirecting to a separate page.Check screen.googleOneTapConfig before rendering the Google One Tap prompt — it is null when the feature is not enabled server-side.
Example
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.googleOneTap({ one_tap_credential: credential });
Method Parameters
​
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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.pickCountryCode();
​
signup
Promise<void>
This method handles signup-id related configuration. It allows signing up new users via different identifiers.
Example
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
signupIdManager.signup({
  email: 'test@example.com',
});
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 SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();
const result = signupIdManager.validateUsername('myusername');
// result => { valid: true, errors: [] }
Method Parameters