Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-staging-quickstart-revamp.mintlify.app/llms.txt

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

​
Signup screen class

The Signup screen class is part of the Identifier First Authentication flow and collects the user’s identifier. Depending on your tenant setup, this identifier can be an email, phone number, or username.
ACUL Signup screen image
Import and instantiate the Signup screen class 
import Signup from '@auth0/auth0-acul-js/signup';
const signupManager = new Signup();

// SDK Properties return a string, number or boolean
// ex. "login-id"
signupManager.screen.name;

// SDK Methods return an object or array
// ex. { signup: "/signup_url", reset_password: "/reset_password_url"} 
signupManager.screenLinks();

​
Properties

The Signup screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Signup screen class methods are:

​
pickCountryCode( options? )

This method redirects the user to the country code selection list, where they can update the country code prefix for their phone number. 
import Signup from "@auth0/auth0-acul-js/signup";
const signupManager = new Signup();

signupManager.pickCountryCode();

​
signup( options? )

This method redirects the user to the next step in the authentication flow. Depending on the server configuration, this screen can include inputs for one or more of the following: email, username, or phone number. For more details, review Flexible Identifiers. 
import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.signup({
 email: 'test@example.com',
 password: 'P@$$wOrd123!',
});
Parameter                 TypeRequiredDescription
emailstringConditionallyThe user’s email.
phonestringConditionallyThe user’s phone number.
usernamestringConditionallyThe user’s username.
passwordstringConditionallyThe user’s password.
captchastringConditionallyThe captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled.
[key: string]string | number | boolean | undefinedNoAdditional data collected from the user. This data is accessible in the pre-user-registration Action trigger.

​
federatedSignup( options? )

This method redirects the user to the social or enterprise (IdP) for authentication. Review Social Identity Providers and Enterprise Identity Providers for details. 
import Signup from '@auth0/auth0-acul-js/signup';

const signupManager = new Signup();

signupManager.federatedSignup({
 connection: 'google-oauth2'
});
ParameterTypeRequiredDescription
connectionstringYesThe identifier for the connection.
[key: string]string | number | boolean | undefinedNoAdditional data collected from the user.

​
Signup ID screen class

The Signup ID screen class is part of the Identifier First Authentication flow and collects the user’s identifier. Depending on your tenant setup, this identifier can be an email, phone number, or username.
Signup ID
Import and instantiate the Signup ID screen class 
import SignupId from '@auth0/auth0-acul-js/signup-id';
const signupIdManager = new SignupId();

// SDK Properties return a string, number or boolean
// ex. "signup-id"
signupIdManager.screen.name;

// SDK Methods return an object or array
// ex. { login: "/login_url"} 
signupIdManager.screenLinks();

​
Properties

The Signup ID screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Signup ID screen class methods are:

​
signup( options? )

This method takes the user to the next step in the authentication flow. Depending on the server configuration, this screen can include inputs for one or more of the following: email, username, or phone number. For more details, review Flexible Identifiers. 
import SignupId from "@auth0/auth0-acul-js/signup-id";

const signupIdManager = new SignupId();
const { transaction } = signupIdManager;

//get mandatory & optional identifiers required for signup
const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email
const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone

const signupParams = {
 email : "testEmail",
 phone : "+91923456789"
};

signupIdManager.signup(signupParams);
Parameter                 TypeRequiredDescription
emailstringConditionallyThe user’s email.
phonestringConditionallyThe user’s phone number.
usernamestringConditionallyThe user’s username.
captchastringConditionallyThe captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled.
[key: string]string | number | boolean | undefinedNoAdditional data collected from the user. This data is accessible in the pre-user-registration Action trigger.

​
federatedSignup( options? )

This method redirects the user to the social or enterprise identity provider (IdP) for authentication. Review Social Identity Providers and Enterprise Identity Providers for details. 
import SignupId from "@auth0/auth0-acul-js/signup-id";

const signupIdManager = new SignupId();
const { transaction } = signupIdManager;

//get social connections
const socialConnection = transaction.getAlternateConnections(); //eg: "google-oauth2"

const signupParams = {
 connection : socialConnection[0].name, // "google-oauth2"
};

signupIdManager.federatedSignup(signupParams);
ParameterTypeRequiredDescription
connectionstringYesThe identifier for the connection.
[key: string]string | number | boolean | undefinedNoAdditional data collected from the user.

​
Signup Password screen class

The Signup Password screen class is part of the Identifier First Authentication flow and allows the user to create a password for their profile.
Signup Password with Flexible IDs
Import and instantiate the Signup Password screen class 
import SignupPassword from '@auth0/auth0-acul-js/signup-password';
const signupPasswordManager = new SignupPassword();

// SDK Properties return a string, number or boolean
// ex. "signup-password"
signupPasswordManager.screen.name;

// SDK Methods return an object or array
// ex. { login: "/login_url", edit_identifier: "/edit_url"} 
signupPasswordManager.screenLinks();

​
Properties

The Signup Password screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Signup Password screen class method is:

​
signup( options? )

This method submits the identifier from the previous step and the provided password to create the user’s account. Once created, the user is directed to the next step. 
signupPasswordManager.signup({
  email: <EmailFieldValue>
  phone: <PhoneFieldValue>
  username: <UsernameFieldValue>
  password: ********
});
Parameter                 TypeRequiredDescription
captchastringConditionallyThe captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled.
emailstringConditionallyThe user’s email.
passwordstringYesThe user’s password.
phonestringConditionallyThe user’s phone number.
usernamestringConditionallyThe user’s username.
[key: string]string | number | boolean | undefinedNoAdditional data collected from the user. This data is accessible in the pre-user-registration Action trigger.

​
Passkey Enrollment screen class

The Passkey Enrollment screen class is part of the Identifier First Authentication flow. It allows the user to create a passkey to use as their authentication credential for all subsequent authentications on your application. Review Passkeys to learn more about using passkeys in Auth0.
Import and instantiate the Passkey Enrollment screen class 
import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment';
const passskeyEnrollmentManager = new PasskeyEnrollment();

// SDK Properties return a string, number or boolean
// ex. "passkey-enrollment"
passskeyEnrollmentManager.screen.name;

// SDK Methods return an object or array
// ex. { back: "/back_url" } 
passskeyEnrollmentManager.screenLinks();

​
Properties

The Passkey Enrollment screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Passkey Enrollment screen class method are:

​
abortPasskeyEnrollment( options? )

This method sends the user to the Signup Password Screen to create their password. 
// This method does not support any parameters
passkeyEnrollment.abortPasskeyEnrollment();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
continuePasskeyEnrollment( options? )

Create a passkey and authenticate the user. After creating the passkey, this method sends the user to the redirect_url. 
// This method does not support any parameters
passkeyEnrollment.continuePasskeyEnrollment();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
Passkey Enrollment Local screen class

The Passkey Enrollment Local screen class is part of the Identifier First Authentication flow. It allows the user to create a passkey to use as their authentication credential for all subsequent authentications on your application. Review Passkeys to learn more about using passkeys in Auth0
Passkey Enrollment Local
Import and instantiate the Passkey Enrollment Local screen class 
import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local';
const passskeyEnrollmentLocalManager = new PasskeyEnrollmentLocal();

// SDK Properties return a string, number or boolean
// ex. "passkey-enrollment-local"
passskeyEnrollmentLocalManager.screen.name;

// SDK Methods return an object or array
// ex. { back: "/back_url" } 
passskeyEnrollmentLocalManager.screenLinks();

​
Properties

The Passkey Enrollment Local screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Passkey Enrollment Local screen class method are:

​
abortPasskeyEnrollment( options )

Skip the passkey creation and provide a password instead. This method sends the user to the Signup Password Screen to create their password. 
passkeyEnrollment.abortPasskeyEnrollment({
  doNotShowAgain: <BooleanFieldValue>
});
ParameterTypeRequiredDescription
doNotShowAgainbooleanYesIndicates whether or not the user wants to be reminded to create a passkey again after skipping initial creation.

​
continuePasskeyEnrollment( options? )

Create a passkey and authenticate the user. After creating the passkey, this operation sends the user to the redirect_url. 
// This method does not support any parameters
passkeyEnrollment.continuePasskeyEnrollment();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
Phone Identifier Challenge screen class

The Phone Identifier Challenge screen class is part of the Identifier First Authentication flow and verifies the user’s phone number before allowing them to sign up. For more details, review Activate and Configure Attributes for Flexible Identifiers.
undefined
Import and instantiate the Phone Identifier Challenge screen class 
import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();

// SDK Properties return a string, number or boolean
// ex. "phone-identifier-challenge"
phoneIdentifierChallengeManager.screen.name;

// SDK Methods return an object or array
// ex. data: { message_type: "text", phone: "+1234567890" };
phoneIdentifierChallengeManager.screenData();

​
Properties

The Phone Identifier Challenge screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Phone Identifier Challenge screen class method are:

​
resendCode( options? )

This method sends a new OTP code to the email provided in the previous step. 
// This method does not support any parameters
phoneIdentifierChallenge.resendCode();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
returnToPrevious( options? )

This method returns the user to the previous step. 
// This method does not support any parameters
phoneIdentifierChallenge.returnToPrevious();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
submitPhoneChallenge( options )

This method verifies the provided phone number and allows the user to continue signing up. 
phoneIdentifierChallenge.submitPhoneChallenge({
    code: "<CodeFieldValue>"
});
ParameterTypeRequiredDescription
captchastringConditionallyThe captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled.
codestringYesThe OTP code sent to the phone number.
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
Phone Identifier Enrollment screen class

The Phone Identifier Enrollment screen class is part of the Identifier First Authentication flow and allows the user to select a method for verifying their phone number before continuing the signup process. For more details, review Activate and Configure Attributes for Flexible Identifiers.
PhoneIdentifierEnrollment
Import and instantiate the Phone Identifier Enrollment screen class 
import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();

// SDK Properties return a string, number or boolean
// ex. "phone-identifier-enrollment"
phoneIdentifierEnrollmentManager.screen.name;

// SDK Methods return an object or array
// ex. { phone_number: "+1234567890" } 
phoneIdentifierEnrollmentManager.screenData();

​
Properties

The Phone Identifier Enrollment screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Phone Identifier Enrollment screen class method are:

​
continuePhoneEnrollment( options )

Send an OTP code via the user’s chosen method to the phone number provided in the previous step. 
phoneIdentifierChallenge.continuePhoneEnrollment({
  type: "text" | "voice"
});
ParameterTypeRequiredDescription
typestringYesPossible values: text or voice
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
returnToPrevious( options? )

This method returns the user to the previous step. 
// This method does not support any parameters
phoneIdentifierChallenge.returnToPrevious();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
Email Identifier Challenge screen class

The Email Identifier Challenge screen class is part of the Identifier First Authentication flow and verifies the user’s email address before allowing them to sign up. For more details, review Activate and Configure Attributes for Flexible Identifiers.
Import and instantiate the Email Identifier Challenge screen class: 
import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();

// SDK Properties return a string, number or boolean
// ex. "email-identifier-challenge"
emailIdentifierChallengeManager.screen.name;

// SDK Methods return an object or array
// ex. { email: "someone@example.com" } 
emailIdentifierChallengeManager.screenData();

​
Properties

The Email Identifier Challenge screen class properties are: 
interface branding {
  settings: null | BrandingSettings;
  themes: null | BrandingThemes;
}

interface BrandingSettings {
  colors?: {
    pageBackground?: string | {
      angleDeg: number;
      end: string;
      start: string;
      type: string;
    };
    primary?: string;
  };
  faviconUrl?: string;
  font?: {url: string;};
  logoUrl?: string;
}

interface BrandingThemes {
  default: {
    borders: Record<string, string | number | boolean>;
    colors: Record<string, string>;
    displayName: string;
    fonts: Record<string, string | boolean | object>;
    pageBackground: Record<string, string>;
    widget: Record<string, string | number>;
  };
}

​
Methods

The Email Identifier Challenge screen class methods are:

​
resendCode( options? )

This method sends a new OTP code to the email provided in the previous step. 
// This method does not support any parameters
emailIdentifierChallenge.resendCode();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
returnToPrevious( options? )

This method returns the user to the previous step. 
// This method does not support any parameters
emailIdentifierChallenge.returnToPrevious();
Parameter                 TypeRequiredDescription
[key: string]string | number | boolean | undefinedNoOptional data collected from user.

​
submitEmailChallenge( options? )

This method verifies the provided email address and allows the user to continue signing up. 
emailIdentifierChallenge.submitEmailChallenge({
  code: <CodeFieldValue>
});
ParameterTypeRequiredDescription
captchastringConditionallyThe captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled.
codestringYesThe OTP code sent to the email address.
[key: string]string | number | boolean | undefinedNoAdditional data collected from the user.