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

googleOneTap

• googleOneTap(payload: Screens.GoogleOneTapOptions): Promise<void>

  Submits the Google ID token obtained from the Google Identity Services (GSI) SDK to complete sign-up via Google One Tap.

  Check screen.googleOneTapConfig first — it is null when the feature is not enabled server-side, in which case this method should not be called.

  Parameters

  • payload: Screens.GoogleOneTapOptions

    one_tap_credential: the ID token returned by the GSI callback.

  Returns Promise<void>

  Remarks

  Requires the Google Identity Services (GSI) script to be loaded before calling this method. Add it to your HTML: <script src="https://accounts.google.com/gsi/client" async></script> Or inject it dynamically at runtime.

  See

  • Google Identity Services: Load the client library
  • Auth0 Google Social Connection

  Example

  import SignupId from "@auth0/auth0-acul-js/signup-id";
  
  const signupIdManager = new SignupId();
  const config = signupIdManager.screen.googleOneTapConfig;
  
  if (config) {
    const script = document.createElement('script');
    script.src = 'https://accounts.google.com/gsi/client';
    script.async = true;
    script.defer = true;
    script.onload = () => {
      window.google?.accounts.id.initialize({
        client_id: config.client_id,
        nonce: config.nonce,
        context: config.context,
        itp_support: config.itp_support,
        auto_select: config.auto_select,
        cancel_on_tap_outside: config.cancel_on_tap_outside,
        callback: ({ credential }) => {
          signupIdManager.googleOneTap({ one_tap_credential: credential });
        },
      });
      window.google?.accounts.id.prompt();
    };
    document.head.appendChild(script);
  }
  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