Class SignupPassword

constructor

• new SignupPassword(): SignupPassword

  Returns SignupPassword

screen

transaction

StaticscreenIdentifier

federatedSignup

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

  Parameters

  • payload: Screens.FederatedSignupPasswordPayloadOptions

  Returns 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);
  Copy

signup

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

  Parameters

  • payload: Screens.SignupPasswordOptions

  Returns 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);
  Copy

switchConnection

• switchConnection(
      payload: Screens.SwitchConnectionOptionsSignupPassword,
  ): Promise<void>

  Parameters

  • payload: Screens.SwitchConnectionOptionsSignupPassword

  Returns Promise<void>

  Remarks

  This method handles switching between different database connections. It allows users to switch to a different connection during the signup process.

  Example

  import SignupPassword from "@auth0/auth0-acul-js/signup-password";
  
  const signupPasswordManager = new SignupPassword();
  
  // Function to handle connection switching
  const handleSwitchConnection = (connectionName: string) => {
    signupPasswordManager.switchConnection({ connection: connectionName });
  };
  
  // Switch to different connection strategies
  handleSwitchConnection('email'); // Switch to email-based authentication
  handleSwitchConnection('sms');   // Switch to SMS-based authentication
  Copy

validatePassword

• validatePassword(password: string): Screens.PasswordValidationResult
  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.

  Parameters

  • password: string

    The password string to validate.

  Returns Screens.PasswordValidationResult

  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 },
  //   ...
  // ]
  Copy