StaticscreenUtility FeatureLanguage 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'
});
This methods handles allows signup via different social identifiers. Eg: Google, Facebook etc.
import SignupId from "@auth0/auth0-acul-js/signup-id";
const signupIdManager = new SignupId();
const { transaction } = signupIdManager;
//get social connections
const socialConnection = transaction.alternateConnections; //eg: "google-oauth2"
const signupParams = {
connection : socialConnection[0].name, // "google-oauth2"
};
signupIdManager.federatedSignup(signupParams);
Utility FeatureReturns the list of enabled identifiers for the signup-id form, marking each as required or optional based on transaction config.
Array of identifier objects (e.g., email, phone, username).
This methods handles signup-id related configuration. It allows to signup new users via different identifiers.
import SignupId from "@auth0/auth0-acul-js/signup-id";
const signupIdManager = new SignupId();
const { transaction } = signupIdManager;
//get mandatory & optional identifiers required for signup
const mandatoryIdentifier = transaction.getRequiredIdentifiers(); // eg: email
const optionalIdentifiers = transaction.getOptionalIdentifiers() // eg: phone
const signupParams = {
email : "testEmail",
phone : "+91923456789"
};
signupIdManager.signup(signupParams);
Utility FeatureValidates a given username against the current username policy defined in the transaction context.
The username string to validate.
Result object indicating whether the username is valid and why.
Changes 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.