SignupMembers

Example

export interface SignupMembers extends BaseMembers {
  screen: ScreenMembersOnSignup;
  transaction: TransactionMembersOnSignup;
  signup(payload: SignupOptions): Promise<void>;
  federatedSignup(payload: FederatedSignupOptions): Promise<void>;
  pickCountryCode(payload?: CustomOptions): Promise<void>;
  validatePassword(password: string): PasswordValidationResult;
  /**
 * 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 An array of enabled {@link Identifier} objects, or `null` if the transaction is not initialized.
 *
 * @example
 * ```ts
 * const identifiers = authClient.getSignupIdentifiers();
 * if (identifiers) {
 *   identifiers.forEach(({ type, required }) => {
 *     console.log(`${type} is ${required ? 'required' : 'optional'}`);
 *   });
 * }
 * ```
 * @utilityFeature
 * @see Identifier
 */
  getSignupIdentifiers(): Identifier[] | null;
  validateUsername(username: string): UsernameValidationResult;
}

Properties

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnSignup

tenant · TenantMembers

transaction · TransactionMembersOnSignup

untrustedData · UntrustedDataMembers

user · UserMembers

Methods

federatedSignup · Promise<void>

Show Parameters

payload · FederatedSignupPayloadOptions

Properties

connection · string

getSignupIdentifiers · Identifier []

Utility Feature

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.

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

Example

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

pickCountryCode · Promise<void>

Show Parameters

payload? · CustomOptions

signup · Promise<void>

Show Parameters

payload · SignupPayloadOptions

Properties

captcha? · string

email? · string

password? · string

phoneNumber? · string

username? · string

validatePassword · PasswordValidationResult

Show Parameters

password · string

validateUsername · UsernameValidationResult

Show Parameters

username · string