Skip to main content
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
client
organization
prompt
screen
tenant
transaction
untrustedData
user

Methods

federatedSignup
Promise<void>
getSignupIdentifiers
Utility FeatureReturns 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>
signup
Promise<void>
validatePassword
validateUsername