Creates an instance of the MfaPhoneEnrollment screen.
StaticscreenUtility FeatureChanges the language/locale for the current authentication flow.
This method triggers a language change by submitting the new locale preference to the server with the 'change-language' action. The language change will cause the current screen to re-render with the new locale.
Language change options including the target language code
Options for changing the language/locale during the authentication flow
Additional custom fields to be submitted along with the language change. Custom fields should be prefixed with 'ulp-'.
Short language name (locale code) to be set (e.g., 'en', 'fr', 'es').
Optionalpersist?: "session"Defines persistence scope for the language preference. Currently only 'session' is supported.
A promise that resolves when the form submission is complete
import LoginId from "@auth0/auth0-acul-js/login-id";
const loginManager = new LoginId();
// Change language to French
await loginManager.changeLanguage({
language: 'fr',
persist: 'session'
});
import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
// Change language to Spanish with additional custom data
await loginPasswordManager.changeLanguage({
language: 'es',
persist: 'session',
'ulp-custom-field': 'custom-value'
});
Continues the enrollment process with the provided phone number and type (SMS or voice).
The phone number and type (SMS or voice).
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';
const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment();
async function handleContinueEnrollment() {
try {
await mfaPhoneEnrollmentManager.continueEnrollment({
phone: '+1234567890',
type: 'sms', // or 'voice'
});
console.log('Phone enrollment continued successfully.');
} catch (error) {
console.error('Error continuing phone enrollment:', error);
}
}
Navigates to the country code selection screen.
Optionalpayload: Screens.CustomOptionsOptional custom options to include with the request.
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';
const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment();
async function handlePickCountryCode() {
try {
await mfaPhoneEnrollmentManager.pickCountryCode();
console.log('Country code selection successful.');
} catch (error) {
console.error('Error selecting country code:', error);
}
Allows the user to try another MFA method.
Optionalpayload: Screens.CustomOptionsOptional custom options to include with the request.
import MfaPhoneEnrollment from '@auth0/auth0-acul-js/mfa-phone-enrollment';
const mfaPhoneEnrollmentManager = new MfaPhoneEnrollment();
async function handleTryAnotherMethod() {
try {
await mfaPhoneEnrollmentManager.tryAnotherMethod();
console.log('Switched to another authentication method.');
} catch (error) {
console.error('Error switching authenticator method:', error);
}
}
Class implementing the mfa-phone-enrollment screen functionality. This screen allows users to enroll using a phone number for MFA.