Signup Password Screen

The Signup Password screen is part of the Identifier First Authentication flow and allows the user to create a password for their profile.

Signup Password

Context Data

The Universal Login Context Data contains unique-per-screen transaction and configuration data. Optional context data can be configured in the Management API with the context_configuration parameter. Read Universal Login Context for information about context data and read Configure Screens for details about optional context data.

interface SignupPassword {
  client: Client;
  organization?: Organization;
  prompt: Prompt;
  screen: {
    name: string;
    links?: {
      login: string;
      edit_identifier: string;
    };
    data: {
      email?: string;
      phone?: string;
      username?: string;
    };
  };
  transaction: {
    state: string;
    locale: string;
    errors?: Error[];
    connection: DbConnection | PasswordlessConnection;
    alternate_connections?: Connection[];
  };
};

Was this helpful?

/

Accessing Context Data

Using the Auth0 ACUL JS SDK to access the context data for each screen is recommended. The SDK provides properties and methods that simplify accessing the data.

Initialize the SignupPassword class to access its properties and methods.

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();

Was this helpful?

/

SDK Properties & Methods

The following screen-specific properties and methods are available on this screen:

Property or Method Type Description
screen.editLink

string

Link to the edit link flow.

screen.loginLink

string

Link to the login flow.

transaction.isPasskeyEnabled

boolean

Are passkeys enabled?

transaction.getOptionalIdentifiers()

string

Which optional identifiers can the user sign up with?

transaction.getPasswordPolicy()

object

What is the password policy to be applied?

transaction.getRequiredIdentifiers()

object

What are the required identifiers?

Screen Operations

The Signup Password screen supports the following operations.

Continue with Password

Continue the transaction with the user's password. This operation 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.

JS SDK Method: signup()

Parameter                  Type Required Description
email string Conditionally The user’s email.
phone string Conditionally The user’s phone number.
username string Conditionally The user’s username.
ulp-${my-field} string No Additional data collected from the user. This data is accessible in the pre-user-registration Action trigger. 

signupPasswordManager.signup({
  email: <EmailFieldValue>
  phone: <PhoneFieldValue>
  username: <UsernameFieldValue>
  password: ********
});

Was this helpful?

/