@auth0/auth0-acul-react - v1.9.0
    Preparing search index...

    Interface SignupMembers

    interface SignupMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        tenant: TenantMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        screen: ScreenMembersOnSignup;
        transaction: TransactionMembersOnSignup;
        signup(payload: SignupPayloadOptions): Promise<void>;
        federatedSignup(payload: FederatedSignupPayloadOptions): Promise<void>;
        googleOneTap(payload: GoogleOneTapOptions): Promise<void>;
        pickCountryCode(payload?: CustomOptions): Promise<void>;
        validatePassword(password: string): PasswordValidationResult;
        getSignupIdentifiers(): Identifier[] | null;
        validateUsername(username: string): UsernameValidationResult;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding client countryCodes? experiment? organization prompt tenant user untrustedData screen transaction

    Methods

    getErrors changeLanguage signup federatedSignup googleOneTap pickCountryCode validatePassword getSignupIdentifiers validateUsername

    Properties

    branding: BrandingMembers
    client: ClientMembers
    countryCodes?: CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: OrganizationMembers
    prompt: PromptMembers
    tenant: TenantMembers
    user: UserMembers
    untrustedData: UntrustedDataMembers
    screen: ScreenMembersOnSignup
    transaction: TransactionMembersOnSignup

    Methods

    • Returns Error[]

    • Parameters

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Returns a list of enabled identifiers (e.g. email, phone, username) based on the current transaction state.

      Identifiers may be required or optional depending on the connection strategy and configuration provided during the authentication or signup flow.

      Returns Identifier[] | null

      An array of enabled Identifier objects, or null if the transaction is not initialized.

      const identifiers = authClient.getSignupIdentifiers();
      if (identifiers) {
        identifiers.forEach(({ type, required }) => {
          console.log(`${type} is ${required ? 'required' : 'optional'}`);
        });
      }

      Identifier

    Settings

    Member Visibility

    On This Page

    Properties
    Methods