Skip to main content
Signup ID
Example
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);

​
Constructors

​
SignupId
Constructor

​
Properties

​
branding
​
client
​
organization
​
prompt
​
screen
​
tenant
​
transaction
​
untrustedData
​
user
​
screenIdentifier
string

​
Methods

​
federatedSignup
Promise<void>

​
Remarks

This methods handles allows signup via different social identifiers. Eg: Google, Facebook etc.
Example
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);
​
getErrors
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.
​
getSignupIdentifiers
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).
Example
const signupId = new SignupId();
const identifiers = signupId.getSignupIdentifiers();
// [{ type: 'email', required: true }, { type: 'username', required: false }]
​
pickCountryCode
Promise<void>
Example
import SignupId from "@auth0/auth0-acul-js/signup-id";
const signupIdManager = new SignupId();

signupIdManager.pickCountryCode();
​
signup
Promise<void>

​
Remarks

This methods handles signup-id related configuration. It allows to signup new users via different identifiers.
Example
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);
​
validateUsername
Utility FeatureValidates a given username against the current username policy defined in the transaction context.Result object indicating whether the username is valid and why.
Example
const signupIdManager = new SignupId();
const result = signupIdManager.validateUsername('myusername');
// result => { valid: true, errors: [] }