Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
spotify

providers/spotify

Built-in Spotify integration.

SpotifyImage

Properties

url

url: string;

SpotifyProfile

Extends

  • Record<string, any>

Properties

display_name

display_name: string;

email

email: string;

id

id: string;

images

images: SpotifyImage[];

default()

default<P>(options): OAuthConfig<P>

Add Spotify login to your page.

Setup

Callback URL

https://example.com/api/auth/callback/spotify

Configuration

import Auth from "@auth/core"
import Spotify from "@auth/core/providers/spotify"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [Spotify({ clientId: SPOTIFY_CLIENT_ID, clientSecret: SPOTIFY_CLIENT_SECRET })],
})

Resources

Notes

By default, Auth.js assumes that the Spotify provider is based on the OAuth 2 specification.

💡

The Spotify provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Type parameters

Type parameter
P extends SpotifyProfile

Parameters

ParameterType
optionsOAuthUserConfig<P>

Returns

OAuthConfig<P>

Auth.js © Balázs Orbán and Team - 2024