Auth

Login with X / Twitter

To enable X / Twitter Auth for your project, you need to set up an X OAuth 2.0 application and add the application credentials in the Supabase Dashboard.

Overview

Setting up X / Twitter logins for your application consists of 3 parts:

Access your X developer account

Find your callback URL

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 Sign In / Providers under the Configuration section
  • Click on X / Twitter (OAuth 2.0) from the accordion list to expand and you'll find your Callback URL, you can click Copy to copy it to the clipboard

Create an X OAuth app

  • Click + Create Project.
    • Enter your project name, click Next.
    • Select your use case, click Next.
    • Enter a description for your project, click Next.
    • Enter a name for your app, click Next.
    • Copy and save your API Key (this is your client_id).
    • Copy and save your API Secret Key (this is your client_secret).
    • Click on App settings to proceed to next steps.
  • At the bottom, you will find User authentication settings. Click on Set up.
  • Under User authentication settings, you can configure App permissions.
  • Make sure you turn ON Request email from users.
  • Select Web App... as the Type of App.
  • Under App info configure the following.
    • Enter your Callback URL. Check the Find your callback URL section above to learn how to obtain your callback URL.
    • Enter your Website URL (tip: try http://127.0.0.1:port or http://www.localhost:port during development)
    • Enter your Terms of service URL.
    • Enter your Privacy policy URL.
  • Click Save.

Enter your X credentials 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 X / Twitter (OAuth 2.0) from the accordion list to expand and turn X / Twitter (OAuth 2.0) Enabled to ON
  • Enter your X / Twitter (OAuth 2.0) Client ID and X / Twitter (OAuth 2.0) Client Secret saved in the previous step
  • Click Save

You can also configure the X / Twitter (OAuth 2.0) auth provider using the Management API:

1
# Get your access token from https://supabase.com/dashboard/account/tokens
2
export SUPABASE_ACCESS_TOKEN="your-access-token"
3
export PROJECT_REF="your-project-ref"
4
5
# Configure X / Twitter (OAuth 2.0) auth provider
6
curl -X PATCH "https://api.supabase.com/v1/projects/$PROJECT_REF/config/auth" \
7
  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
8
  -H "Content-Type: application/json" \
9
  -d '{
10
    "external_x_enabled": true,
11
    "external_x_client_id": "your-x-api-key",
12
    "external_x_secret": "your-x-api-secret-key"
13
  }'

Add login code to your client app

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

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

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
await ..({
2
  ,
3
  : {
4
    : `http://example.com/auth/callback`,
5
  },
6
})

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

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

1
async function () {
2
  const {  } = await ..()
3
}

Resources