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 LoginEmailVerification class implements the login-email-verification screen functionality. This screen prompts the user to enter a one-time code sent to their email address to verify their identity during the login process.

​
Constructors

Create an instance of LoginEmailVerification screen manager:
Example
import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

​
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-email-verification 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
ScreenMembers
Contains details specific to the login-email-verification screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembers
Provides transaction-specific data for the login-email-verification 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 LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.changeLanguage({
  language: 'fr',
});
Method Parameters
​
continueWithCode
Promise<void>
This method submits the email verification code entered by the user.
Example
import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});
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.
​
resendCode
Promise<void>
This method requests a new verification code to be sent to the user’s email address.
Example
import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.resendCode();
Method Parameters
​
resendManager
ResendControl
This method provides resend functionality with timeout management. It returns a ResendControl object with a startResend() method that triggers the resend and enforces a cooldown period before the user can resend again.
Example
import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';

const loginEmailVerificationManager = new LoginEmailVerification();
const { startResend } = loginEmailVerificationManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// Call startResend when user clicks resend button
startResend();
Method Parameters