Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
facebook

providers/facebook

Built-in Facebook integration.

FacebookProfile

Extends

  • Record<string, any>

Properties

id

id: string;

picture

picture: FacebookPicture;

default()

default<P>(options): OAuthConfig<P>

Add Facebook login to your page.

Setup

Callback URL

https://example.com/api/auth/callback/facebook

Configuration

import { Auth } from "@auth/core"
import Facebook from "@auth/core/providers/facebook"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Facebook({
      clientId: FACEBOOK_CLIENT_ID,
      clientSecret: FACEBOOK_CLIENT_SECRET,
    }),
  ],
})

Resources

Notes

💡

Production applications cannot use localhost URLs to sign in with Facebook. You need to use a dedicated development application in Facebook to use localhost callback URLs.

💡

Email address may not be returned for accounts created on mobile.

By default, Auth.js assumes that the Facebook provider is based on the OAuth 2 specification.

💡

The Facebook provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Type parameters

Type parameter
P extends FacebookProfile

Parameters

ParameterType
optionsOAuthUserConfig<P>

Returns

OAuthConfig<P>

Auth.js © Balázs Orbán and Team - 2024