Class Signup

constructor

• new Signup(): Signup

  Returns Signup

screen

transaction

StaticscreenIdentifier

federatedSignup

• federatedSignup(payload: Screens.FederatedSignupPayloadOptions): Promise<void>

  Handles the submission of the social signup form.

  Parameters

  • payload: Screens.FederatedSignupPayloadOptions

    The payload containing the social signup options.

  Returns Promise<void>

  Remarks

  This method 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'
  });
  Copy

getSignupIdentifiers

• getSignupIdentifiers(): Screens.Identifier[] | null
  Utility Feature

  Returns the list of enabled identifiers for the signup form, marking each as required or optional based on transaction config.

  Returns Screens.Identifier[] | null

  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 }]
  Copy

pickCountryCode

• pickCountryCode(): Promise<void>

  Returns Promise<void>

  Example

  import Signup from "@auth0/auth0-acul-js/signup";
  const signupManager = new Signup();
  
  signupManager.pickCountryCode();
  Copy

signup

• signup(payload: Screens.SignupPayloadOptions): Promise<void>

  Parameters

  • payload: Screens.SignupPayloadOptions

  Returns Promise<void>

  Remarks

  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!',
  });
  Copy

validatePassword

• validatePassword(password: string): Screens.PasswordValidationResult
  Utility Feature

  Parameters

  • password: string

  Returns Screens.PasswordValidationResult

  An object of type PasswordValidationResult indicating whether the password is valid and why.

validateUsername

• validateUsername(username: string): Screens.UsernameValidationResult
  Utility Feature

  Validates a given username against the current username policy defined in the transaction context.

  Parameters

  • username: string

    The username string to validate.

  Returns Screens.UsernameValidationResult

  Result object indicating whether the username is valid and why.

  Example

  const signup = new Signup();
  const result = signup.validateUsername('myusername');
  // result => { valid: true, errors: [] }
  Copy