Facebook Provider

Package: @nauth-toolkit/social-facebook Type: Social Auth Provider

npm

npm install @nauth-toolkit/social-facebook

Yarn

yarn add @nauth-toolkit/social-facebook

pnpm

pnpm add @nauth-toolkit/social-facebook

Bun

bun add @nauth-toolkit/social-facebook

Exports

Export	Type	Entry
FacebookSocialAuthService	Class	Default
FacebookOAuthClient	Class	Default
TokenVerifierService	Class	Default
VerifiedFacebookTokenProfile	Interface	Default
FacebookSocialAuthModule	NestJS Module	/nestjs

Configuration

Configure Facebook under config.social.facebook (in @nauth-toolkit/core config).

Key	Type	Required	Description
enabled	boolean	No	Enable Facebook OAuth
clientId	string	Yes (if enabled)	Facebook App ID
clientSecret	string	Yes (if enabled)	Facebook App Secret
callbackUrl	string	Yes (if enabled)	Backend callback URL (/auth/social/facebook/callback)
scopes	string[]	No	Default: ['email', 'public_profile']
autoLink	boolean	No	Auto-link to existing users by verified email
allowSignup	boolean	No	Allow creating new users on first login
oauthParams	Record<string, string>	No	Additional OAuth parameters to include in authorization URL. These act as defaults and can be overridden on a per-request basis.

OAuth Parameters

The oauthParams option allows you to customize the Facebook OAuth authorization flow. These parameters are appended to Facebook's authorization URL and can be overridden on a per-request basis from the frontend.

Common Parameters:

• auth_type: Authentication type
  • 'reauthenticate' - Force user to re-authenticate
  • 'rerequest' - Re-request declined permissions
• display: UI display mode
  • 'page' - Full-page redirect (default)
  • 'popup' - Popup window
  • 'touch' - Mobile-optimized UI
• auth_nonce: For replay attack prevention

Example:

social: {
  facebook: {
    enabled: true,
    clientId: process.env.FACEBOOK_APP_ID,
    clientSecret: process.env.FACEBOOK_APP_SECRET,
    callbackUrl: 'https://api.myapp.com/auth/social/facebook/callback',
    scopes: ['email', 'public_profile'],
    oauthParams: {
      auth_type: 'rerequest',  // Always rerequest declined permissions
      display: 'popup',         // Use popup window
    },
  },
}

See Social Login Guide for usage examples.

Usage

NestJS

import { FacebookSocialAuthModule } from '@nauth-toolkit/social-facebook/nestjs';

@Module({
  imports: [AuthModule.forRoot(config), FacebookSocialAuthModule],
})
export class AppModule {}

Express

const nauth = await NAuth.create({
  config,
  dataSource,
  adapter: new ExpressAdapter(),
});

Fastify

const nauth = await NAuth.create({
  config,
  dataSource,
  adapter: new FastifyAdapter(),
});

Profile Data

Field	Type	Description
id	string	Facebook user ID
email	string?	Email (if permission granted)
name	string	Display name
picture	string	Profile picture URL

Related

• SocialAuthService
• Social Auth