Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-staging.auth0-mintlify.app/llms.txt

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

The LoginPassword class implements the login-password screen functionality. This screen collects the user’s identifier and password.

​
Constructors

Create an instance of LoginPassword screen manager:
Example
import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.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-password 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
ScreenMembersOnLoginPassword
Contains details specific to the login-password screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembersOnLoginPassword
Provides transaction-specific data for the login-password 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 LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.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 LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.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.
​
login
Promise<void>
This method authenticates the user based on the identifier and provided password.
Example
import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.login({
  username: "testUser",
  password: "testPassword"
});
Method Parameters
​
switchConnection
Promise<void>
This method switches between a database connection (password) and a passwordless connection (Email/SMS OTP).
Example
import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
loginPasswordManager.switchConnection({
  connection: "email"
});
Method Parameters