Login

Describes all the properties and methods available to customize the Universal Login login screen.

The Login class implements the login screen functionality. This screen collects the user’s identifier and password. Depending on your tenant, this identifier can be an email, phone number, or username. It also supports authentication via federated identity providers and Google One Tap.

Constructors

Create an instance of Login screen manager:

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.login({
  username: "testUser",
  password: "testPassword"
});

Properties

branding · BrandingMembers

Provides branding-related configurations, such as branding theme and settings.

client · ClientMembers

Provides client-related configurations, such as id, name, and logoUrl, for the login screen.

organization · OrganizationMembers

Provides information about the user’s Organization, such as id and name.

prompt · PromptMembers

Contains data about the current prompt in the authentication flow.

screen · ScreenMembersOnLogin

Contains details specific to the login screen, including its configuration and context.

tenant · TenantMembers

Contains data related to the tenant, such as id and associated metadata.

transaction · TransactionMembersOnLogin

Provides transaction-specific data for the login screen, such as active identifiers and flow states.

untrustedData · UntrustedDataMembers

Handles untrusted data passed to the SDK, such as user input during login.

user · UserMembers

Details of the active user, including username, email, and roles.

Methods

changeLanguage · Promise<void>

This method changes the display language of the Universal Login page.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.changeLanguage({
  language: 'fr',
});

Method Parameters

Show Parameters

options

LanguageChangeOptions.

language · string · required

The locale code for the desired language (for example, 'en', 'fr', 'es').

persist? · "session"

When set to 'session', the selected language persists for the duration of the session.

federatedLogin · Promise<void>

This method redirects the user to the Social or Enterprise Identity Provider (IdP) for authentication.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.federatedLogin({
  connection: "google-oauth2"
});

Method Parameters

Show Parameters

connection · string · required

The Social or Enterprise Identity Provider connection name.

getErrors · Error []

This method 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.

getLoginIdentifiers · ScreenIdentifierType [] | null

This method returns the active identifier types for the login screen.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.getLoginIdentifiers();

login · Promise<void>

This method authenticates the user based on the identifier and provided password.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.login({
  username: "testUser",
  password: "testPassword"
});

Method Parameters

Show Parameters

options

LoginPayloadOptions.

username · string · required

The user’s identifier.

password · string · required

The user’s password.

captcha? · string

The 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" | "undefined"

Additional custom fields prefixed with ulp- (for example, 'ulp-custom-field').

googleOneTap · Promise<void>

This method authenticates the user using a Google One Tap credential, enabling one-click sign-in without redirecting to a separate login page.

Check screen.googleOneTapConfig before rendering the Google One Tap prompt — it is null when the feature is not enabled server-side.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.googleOneTap({ one_tap_credential: credential });

Method Parameters

Show Parameters

one_tap_credential · string · required

The Google One Tap credential token returned by the Google Identity Services prompt.

pickCountryCode · Promise<void>

This method redirects the user to the country code selection list, where they can update the country code prefix for their phone number.

Example

import Login from "@auth0/auth0-acul-js/login";
const loginManager = new Login();
loginManager.pickCountryCode();