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 Zuvo Studio.
Overview
Setting up X / Twitter logins for your application consists of 3 parts:
- Create and configure an X Project and App on the X Developer Dashboard.
- Add your X OAuth 2.0
Client IDandClient Secretto your Zuvo Project. - Add the login code to your Zuvo JS Client App.
Access your X developer account
- Go to developer.x.com.
- Click on
Sign inat the top right to log in.
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 Zuvo Project Dashboard
- Click on the
Authenticationicon in the left sidebar - Click on
Sign In / Providersunder the Configuration section - Click on provider from the accordion list to expand and you'll find your Callback URL, you can click
Copyto copy it to the clipboard
Local development
When testing OAuth locally with the Zuvo CLI, ensure your OAuth provider is configured with the local Zuvo Auth callback URL:
http://localhost:54321/auth/v1/callback
If this callback URL is missing or misconfigured, OAuth sign-in may fail or not redirect correctly during local development.
See the local development docs for more details.
For testing OAuth locally with the Zuvo CLI see the local development docs.
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 and API Secret Key (these are used for OAuth 1.0a, which is being deprecated).
- Click on
App settingsto proceed to next steps.
- Enter your project name, click
- At the bottom, you will find
User authentication settings. Click onSet up. - Under
User authentication settings, you can configureApp permissions. - Make sure you turn ON
Request email from users. - Select
Web App...as theType of App. - Under
App infoconfigure 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: tryhttp://127.0.0.1:portorhttp://www.localhost:portduring development) - Enter your
Terms of service URL. - Enter your
Privacy policy URL.
- Enter your
- Click
Save. - After saving, navigate to
Keys and tokenson your App page.- Scroll to the bottom of the page and copy your Client ID.
- Click the
Regeneratebutton next to Client Secret. - In the confirmation modal, click
Yes, regenerate. - Copy and save your Client Secret.
Enter your X credentials into your Zuvo project
- Go to your Zuvo Project Dashboard
- In the left sidebar, click the
Authenticationicon (near the top) - Click on
Providersunder the Configuration section - Click on provider from the accordion list to expand and turn provider Enabled to ON
- Enter your provider Client ID and provider 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:
# Get your access token from https://studio.zuvodev.com/account/tokens
export SUPABASE_ACCESS_TOKEN="your-access-token"
export PROJECT_REF="your-project-ref"
# Configure X / Twitter (OAuth 2.0) auth provider
curl -X PATCH "https://api.zuvodev.com/v1/projects/$PROJECT_REF/config/auth" \
-H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"external_x_enabled": true,
"external_x_client_id": "your-x-client-id",
"external_x_secret": "your-x-client-secret"
}'
Add login code to your client app
When your user signs in, call signInWithOAuth() with x as the provider:
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
// ---cut---
async function signInWithX() {
const { data, error } = await supabase.auth.signInWithOAuth({
provider: 'x',
})
}
When your user signs in, call signInWithOAuth() with x as the provider:
Future<void> signInWithX() async {
await supabase.auth.signInWithOAuth(
OAuthProvider.x,
redirectTo: kIsWeb ? null : 'my.scheme://my-host', // Optionally set the redirect link to bring back the user via deeplink.
authScreenLaunchMode:
kIsWeb ? LaunchMode.platformDefault : LaunchMode.externalApplication, // Launch the auth screen in a new webview on mobile.
);
}
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.
import { createClient, type Provider } from '@supabase/supabase-js';
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
const provider = 'provider' as Provider
// ---cut---
await supabase.auth.signInWithOAuth({
provider,
options: {
redirectTo: `http://example.com/auth/callback`,
},
})
In the server, you need to handle the redirect to the OAuth provider's authentication endpoint. The signInWithOAuth method returns the endpoint URL, which you can redirect to.
import { createClient, type Provider } from '@supabase/supabase-js'
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
const provider = 'provider' as Provider
const redirect = (url: string) => {}
// ---cut---
const { data, error } = await supabase.auth.signInWithOAuth({
provider,
options: {
redirectTo: 'http://example.com/auth/callback',
},
})
if (data.url) {
redirect(data.url) // use the redirect API for your server framework
}
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:
import { NextResponse } from 'next/server'
// The client you created from the Server-Side Auth instructions
import { 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`)
}
Create a new file at src/routes/auth/callback/+server.js and populate with the following:
import { redirect } from '@sveltejs/kit';
export const GET = async (event) => {
const {
url,
locals: { supabase }
} = event;
const code = url.searchParams.get('code') as string;
const next = url.searchParams.get('next') ?? '/';
if (code) {
const { error } = await supabase.auth.exchangeCodeForSession(code)
if (!error) {
redirect(303, `/${next.slice(1)}`);
}
}
// return the user to an error page with instructions
redirect(303, '/auth/auth-code-error');
};
Create a new file at src/pages/auth/callback.ts and populate with the following:
import { createServerClient, parseCookieHeader } from '@supabase/ssr'
import { type APIRoute } from 'astro'
export const GET: APIRoute = async ({ request, cookies, redirect }) => {
const requestUrl = new URL(request.url)
const code = requestUrl.searchParams.get('code')
const next = requestUrl.searchParams.get('next') || '/'
if (code) {
const supabase = createServerClient(
import.meta.env.PUBLIC_SUPABASE_URL,
import.meta.env.PUBLIC_SUPABASE_PUBLISHABLE_KEY,
{
cookies: {
getAll() {
return parseCookieHeader(Astro.request.headers.get('Cookie') ?? '')
},
setAll(cookiesToSet, _headers) {
cookiesToSet.forEach(({ name, value, options }) =>
Astro.cookies.set(name, value, options)
)
},
},
}
)
const { error } = await supabase.auth.exchangeCodeForSession(code)
if (!error) {
return redirect(next)
}
}
// return the user to an error page with instructions
return redirect('/auth/auth-code-error')
}
Create a new file at app/routes/auth.callback.tsx and populate with the following:
import { redirect, type LoaderFunctionArgs } from '@remix-run/node'
import { createServerClient, parseCookieHeader, serializeCookieHeader } from '@supabase/ssr'
export async function loader({ request }: LoaderFunctionArgs) {
const requestUrl = new URL(request.url)
const code = requestUrl.searchParams.get('code')
const next = requestUrl.searchParams.get('next') || '/'
const responseHeaders = new Headers()
if (code) {
const supabase = createServerClient(
process.env.SUPABASE_URL!,
process.env.SUPABASE_PUBLISHABLE_KEY!,
{
cookies: {
getAll() {
return parseCookieHeader(request.headers.get('Cookie') ?? '')
},
setAll(cookiesToSet, cacheHeaders) {
cookiesToSet.forEach(({ name, value, options }) =>
responseHeaders.append('Set-Cookie', serializeCookieHeader(name, value, options))
)
Object.entries(cacheHeaders).forEach(([key, value]) => responseHeaders.set(key, value))
},
},
}
)
const { error } = await supabase.auth.exchangeCodeForSession(code)
if (!error) {
return redirect(next, { headers: responseHeaders })
}
}
// return the user to an error page with instructions
return redirect('/auth/auth-code-error', { headers: responseHeaders })
}
Create a new route in your express app and populate with the following:
...
app.get("/auth/callback", async function (req, res) {
const code = req.query.code
const next = req.query.next ?? "/"
if (code) {
const supabase = createServerClient(
process.env.SUPABASE_URL,
process.env.SUPABASE_PUBLISHABLE_KEY, {
cookies: {
getAll() {
return parseCookieHeader(req.headers.cookie ?? '')
},
setAll(cookiesToSet, headers) {
cookiesToSet.forEach(({ name, value, options }) =>
res.appendHeader('Set-Cookie', serializeCookieHeader(name, value, options))
)
Object.entries(headers).forEach(([key, value]) =>
res.setHeader(key, value)
)
},
},
})
await supabase.auth.exchangeCodeForSession(code)
}
res.redirect(303, `/${next.slice(1)}`)
})
When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:
import { createClient } from '@supabase/supabase-js'
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
// ---cut---
async function signOut() {
const { error } = await supabase.auth.signOut()
}
When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:
Future<void> signOut() async {
await supabase.auth.signOut();
}