Skip to main content

Documentation Index

Fetch the complete documentation index at: https://auth0-feat-authentication-api-migration.mintlify.app/llms.txt

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

The Login class implements the login screen functionality. This screen collects the user’s identifier and password. Depending on your tenant, this identifer can be an email, phone number, or username.
ACUL Login

​
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
​
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
​
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
​
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();
Method Parameters