Signup

Example

import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.signup({
 email: '[e-mail]',
 password: 'P@$wOrd123!',
});

Constructors

Signup · Constructor

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

federatedSignup · Promise<void>

Handles the submission of the social signup form.

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

Show Parameters

payload

Properties

connection · string

getErrors

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

Utility Feature

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

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 · Promise<void>

Example

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

signupManager.pickCountryCode();

signup · 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: '[e-mail]',
 password: 'P@$$wOrd123!',
});

Show Parameters

payload

Properties

captcha? · string

email? · string

password? · string

phoneNumber? · string

username? · string

validatePassword

Utility Feature

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

Show Parameters

password · string

string

validateUsername

Utility Feature

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

Result object indicating whether the username is valid and why.

Example

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

Show Parameters

username · string

string

The username string to validate.