Class SignupId

constructor

• new SignupId(): SignupId

  Returns SignupId

screen

transaction

StaticscreenIdentifier

federatedSignup

• federatedSignup(payload: Screens.FederatedSignupOptions): Promise<void>

  Parameters

  • payload: Screens.FederatedSignupOptions

  Returns 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);
  Copy

getSignupIdentifiers

• getSignupIdentifiers(): Screens.Identifier[] | null
  Utility Feature

  Returns the list of enabled identifiers for the signup-id form, marking each as required or optional based on transaction config.

  Returns Screens.Identifier[] | null

  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 }]
  Copy

pickCountryCode

• pickCountryCode(): Promise<void>

  Returns Promise<void>

  Example

  import SignupId from "@auth0/auth0-acul-js/signup-id";
  const signupIdManager = new SignupId();
  
  signupIdManager.pickCountryCode();
  Copy

signup

• signup(payload: Screens.SignupOptions): Promise<void>

  Parameters

  • payload: Screens.SignupOptions

  Returns 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);
  Copy

validateUsername

• validateUsername(username: string): Screens.UsernameValidationResult
  Utility Feature

  Validates a given username against the current username policy defined in the transaction context.

  Parameters

  • username: string

    The username string to validate.

  Returns Screens.UsernameValidationResult

  Result object indicating whether the username is valid and why.

  Example

  const signupIdManager = new SignupId();
  const result = signupIdManager.validateUsername('myusername');
  // result => { valid: true, errors: [] }
  Copy