Skip to main content
Version: Next

Interface: SocialAuthConfig

Social auth provider configuration.

By default, Wasp stores only the user's provider-specific ID. Use userSignupFields to save provider account details or custom signup state on your Auth.userEntity. Each provider has provider-specific userSignupFields and configFn behavior, documented in the Social Auth docs.

Extends​

  • BaseAuthMethodConfig

Properties​

configFn?​

optional configFn?: Reference<AnyFunction>

Function that returns provider-specific OAuth options (scopes, prompt, etc.). Use this to request extra scopes, such as requesting email/profile data from providers that do not include it by default, or to customize the OAuth flow.

userSignupFields?​

optional userSignupFields?: Reference<AnyObject>

Object that defines extra fields to save on the user during signup (e.g. firstName, address). Each field name must exist on the configured Auth.userEntity.

Each field function receives the data sent from the client and returns the value Wasp saves to the database. For social auth, this data includes provider-specific profile information. If the value is invalid, throw an error. The password field is excluded from this object and handled by Wasp's auth backend.

See Signup Fields Customization.

Inherited from​

BaseAuthMethodConfig.userSignupFields