Auth

Login with Spotify

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

Overview

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

Access your Spotify Developer account

Spotify Developer Portal.

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 Providers under the Configuration section
  • Click on Spotify from the accordion list to expand and you'll find your Callback URL, you can click Copy to copy it to the clipboard

Create a Spotify OAuth app

  • Log into Spotify.
  • Go to the Spotify Developer Dashboard
  • Click Create an App
  • Type your App name
  • Type your App description
  • Check the box to agree with the Developer TOS and Branding Guidelines
  • Click Create
  • Save your Client ID
  • Save your Client Secret
  • Click Edit Settings

Under Redirect URIs:

  • Paste your Supabase Callback URL in the box
  • Click Add
  • Click Save at the bottom

Enter your Spotify 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 Spotify from the accordion list to expand and turn Spotify Enabled to ON
  • Enter your Spotify Client ID and Spotify Client Secret saved in the previous step
  • Click Save

Add login code to your client app

The following outlines the steps to sign in using Spotify with Supabase Auth.

  1. Call the signin method from the client library.
  2. The user is redirected to the Spotify login page.
  3. After completing the sign-in process, the user will be redirected to your app with an error that says the email address needs to be confirmed. Simultaneously the user receives a confirmation email from Supabase Auth.
  4. The user clicks the confirmation link in the email.
  5. The user is brought back to the app and is now signed in.

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


_10
async function signInWithSpotify() {
_10
const { data, error } = await supabase.auth.signInWithOAuth({
_10
provider: 'spotify',
_10
})
_10
}

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.


_10
await supabase.auth.signInWithOAuth({
_10
provider,
_10
options: {
_10
redirectTo: `http://example.com/auth/callback`,
_10
},
_10
})

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

_30
import { NextResponse } from 'next/server'
_30
// The client you created from the Server-Side Auth instructions
_30
import { createClient } from '@/utils/supabase/server'
_30
_30
export async function GET(request: Request) {
_30
const { searchParams, origin } = new URL(request.url)
_30
const code = searchParams.get('code')
_30
// if "next" is in param, use it as the redirect URL
_30
const next = searchParams.get('next') ?? '/'
_30
_30
if (code) {
_30
const supabase = createClient()
_30
const { error } = await supabase.auth.exchangeCodeForSession(code)
_30
if (!error) {
_30
const forwardedHost = request.headers.get('x-forwarded-host') // original origin before load balancer
_30
const isLocalEnv = process.env.NODE_ENV === 'development'
_30
if (isLocalEnv) {
_30
// we can be sure that there is no load balancer in between, so no need to watch for X-Forwarded-Host
_30
return NextResponse.redirect(`${origin}${next}`)
_30
} else if (forwardedHost) {
_30
return NextResponse.redirect(`https://${forwardedHost}${next}`)
_30
} else {
_30
return NextResponse.redirect(`${origin}${next}`)
_30
}
_30
}
_30
}
_30
_30
// return the user to an error page with instructions
_30
return NextResponse.redirect(`${origin}/auth/auth-code-error`)
_30
}

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


_10
async function signOut() {
_10
const { error } = await supabase.auth.signOut()
_10
}

Resources