Auth

Login with Facebook

To enable Facebook Auth for your project, you need to set up a Facebook OAuth application and add the application credentials to your Supabase Dashboard.

Overview

Setting up Facebook logins for your application consists of 3 parts:

Access your Facebook Developer account

Facebook Developer Portal.

Create a Facebook app

  • Click on My Apps at the top right.
  • Click Create App near the top right.
  • Select your app type and click Continue.
  • Fill in your app information, then click Create App.
  • This should bring you to the screen: Add Products to Your App. (Alternatively you can click on Add Product in the left sidebar to get to this screen.)

The next step requires a callback URL, which looks like this: https://<project-ref>.supabase.co/auth/v1/callback

  • Go to your Supabase Project Dashboard
  • Click on the Authentication icon in the left sidebar
  • Click on Providers under the Configuration section
  • Click on Facebook from the accordion list to expand and you'll find your Callback URL, you can click Copy to copy it to the clipboard

Set up Facebook login for your Facebook app

From the Add Products to your App screen:

  • Click Setup under Facebook Login
  • Skip the Quickstart screen, instead, in the left sidebar, click Settings under Facebook Login
  • Enter your callback URI under Valid OAuth Redirect URIs on the Facebook Login Settings page
  • Enter this in the Valid OAuth Redirect URIs box
  • Click Save Changes at the bottom right

Be aware that you have to set the right use case permissions to enable Third party applications to read the email address. To do so:

Under Build Your App, click on Use Cases screen. From there, do the following steps:

  • Click the Edit button in Authentication and Account Creation on the right side. This action will lead to the other page.
  • public_profile is set by default, so make sure it and email have status of Ready for testing in the redirected page.
  • If not, click the Add button in email on right side.

Copy your Facebook app ID and secret

  • Click Settings / Basic in the left sidebar
  • Copy your App ID from the top of the Basic Settings page
  • Under App Secret click Show then copy your secret
  • Make sure all required fields are completed on this screen.

Enter your Facebook app ID and secret into your Supabase project

  • Go to your Supabase Project Dashboard
  • In the left sidebar, click the Authentication icon (near the top)
  • Click on Providers under the Configuration section
  • Click on Facebook from the accordion list to expand and turn Facebook Enabled to ON
  • Enter your Facebook Client ID and Facebook Client Secret saved in the previous step
  • Click Save

You can also configure the Facebook auth provider using the Management API:

1
2
3
4
5
6
7
8
9
10
11
12
13
# Get your access token from https://supabase.com/dashboard/account/tokensexport SUPABASE_ACCESS_TOKEN="your-access-token"export PROJECT_REF="your-project-ref"# Configure Facebook auth providercurl -X PATCH "https://api.supabase.com/v1/projects/$PROJECT_REF/config/auth" \  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "external_facebook_enabled": true,    "external_facebook_client_id": "your-facebook-app-id",    "external_facebook_secret": "your-facebook-app-secret"  }'

Add login code to your client app

When your user signs in, call signInWithOAuth() with facebook as the provider:

1
2
3
4
5
6
7
8
9
import { createClient } from '@supabase/supabase-js'const supabase = createClient('https://your-project.supabase.co', 'sb_publishable_... or anon key')// ---cut---async function signInWithFacebook() {  const { data, error } = await supabase.auth.signInWithOAuth({    provider: 'facebook',  })}

For a PKCE flow, for example in Server-Side Auth, you need an extra step to handle the code exchange. When calling signInWithOAuth, provide a redirectTo URL which points to a callback route. This redirect URL should be added to your redirect allow list.

In the browser, signInWithOAuth automatically redirects to the OAuth provider's authentication endpoint, which then redirects to your endpoint.

1
2
3
4
5
6
7
8
9
10
11
import { createClient, type Provider } from '@supabase/supabase-js';const supabase = createClient('url', 'anonKey')const provider = 'provider' as Provider// ---cut---await supabase.auth.signInWithOAuth({  provider,  options: {    redirectTo: `http://example.com/auth/callback`,  },})

At the callback endpoint, handle the code exchange to save the user session.

Create a new file at app/auth/callback/route.ts and populate with the following:

app/auth/callback/route.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
import { NextResponse } from 'next/server'// The client you created from the Server-Side Auth instructionsimport { createClient } from '@/utils/supabase/server'export async function GET(request: Request) {  const { searchParams, origin } = new URL(request.url)  const code = searchParams.get('code')  // if "next" is in param, use it as the redirect URL  let next = searchParams.get('next') ?? '/'  if (!next.startsWith('/')) {    // if "next" is not a relative URL, use the default    next = '/'  }  if (code) {    const supabase = await createClient()    const { error } = await supabase.auth.exchangeCodeForSession(code)    if (!error) {      const forwardedHost = request.headers.get('x-forwarded-host') // original origin before load balancer      const isLocalEnv = process.env.NODE_ENV === 'development'      if (isLocalEnv) {        // we can be sure that there is no load balancer in between, so no need to watch for X-Forwarded-Host        return NextResponse.redirect(`${origin}${next}`)      } else if (forwardedHost) {        return NextResponse.redirect(`https://${forwardedHost}${next}`)      } else {        return NextResponse.redirect(`${origin}${next}`)      }    }  }  // return the user to an error page with instructions  return NextResponse.redirect(`${origin}/auth/auth-code-error`)}

When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:

1
2
3
4
5
6
7
import { createClient } from '@supabase/supabase-js'const supabase = createClient('https://your-project.supabase.co', 'sb_publishable_... or anon key')// ---cut---async function signOut() {  const { error } = await supabase.auth.signOut()}

Now, you should be able to login with Facebook and alert you to Submit for Login Review when users try to sign into your app. Follow the instructions there to make your app go live for full features and products. You can read more about App Review here.

Resources