SignupPassword

Example

import SignupPassword from "@auth0/auth0-acul-js/signup-password";
const signupPasswordManager = new SignupPassword();
const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!');
console.log(validationResults);
// [
//   { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false },
//   { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true },
//   ...
// ]

Constructors

SignupPassword · Constructor

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

screenIdentifier · string

Methods

federatedSignup · Promise<void>

Remarks

This methods handles allows signup via different social identifiers. Eg: Google, Facebook etc.

Example

import SignupPassword from "@auth0/auth0-acul-js/signup-id";

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

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

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

signupIdManager.federatedSignup(signupParams);

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.

signup · Promise<void>

Remarks

This methods handles signup-password related screen configuration. It allows to proceed with registering signup password along with signup identifiers passed in previous screen

Example

import SignupPassword from "@auth0/auth0-acul-js/signup-password";

const signupPasswordManager = new SignupPassword();
const { transaction, screen } = signupPasswordManager;

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

//get signup data submitted on previous screen from previous screen
const data = transaction.screen.getScreenData(); //eg: email, phone

const signupParams = {
 email : data.email,
 password: "******"
};

signupPasswordManager.signup(signupParams);

Show Parameters

payload

Properties

captcha? · string

email? · string

password · string

phoneNumber? · string

username? · string

validatePassword

Utility Feature

Validates a password string against the current transaction’s password policy.

This method retrieves the password policy from the current transaction context and delegates the actual validation to coreValidatePassword.

It returns an array of validation results, each containing:

• code: the identifier of the password rule,
• policy: a user-friendly description of the rule,
• isValid: boolean indicating if the password passed that rule.

Example

import SignupPassword from "@auth0/auth0-acul-js/signup-password";
const signupPasswordManager = new SignupPassword();
const validationResults = signupPasswordManager.validatePassword('MyP@ssw0rd!');
console.log(validationResults);
// [
//   { code: 'password-policy-length-at-least', policy: 'At least 12 characters', isValid: false },
//   { code: 'password-policy-lower-case', policy: 'Lowercase letters (a-z)', isValid: true },
//   ...
// ]

Show Parameters

password · string

string

The password string to validate.