Payload Auth Plugin configuration options.

PluginOptions

enabled boolean

providers Array

successPath string

allowSignUp boolean



enabled

Type: boolean

Description: Option to either enable or disable the plugin for Payload to use.

Default: true

Optional: Yes.

ts
            {
  enabled: true;
}

        

providers

Type: Array

Description: Array of OAuth or Passkey providers.

Optional: No.

ts
            {
  providers: [
    GoogleAuthProvider({
        client_id: "GOOGLE_CLIENT_ID"
        client_secret: "GOOGLE_CLIENT_SECRET"
    })
  ];
}

        

successPath

Type: string

Description: Path to redirect users on successful sign-in.

Default: "/admin"

Optional: Yes.

ts
            {
  successPath: "/{my-success-path}";
}

        

allowSignUp

Type: boolean

Description: Allows auto sign up and creates user in the collection if doesn't exist. This should be used at the admin's discretion.

Default: false

Optional: Yes.

ts
            {
  allowSignUp: true;
}