Name: KavachOS
Author: KavachOS

Setup

Get credentials

Go to the Spotify Developer Dashboard and create an app. Under Edit Settings, add your redirect URI:

https://your-app.com/api/kavach/auth/oauth/callback/spotify

Copy the Client ID and Client Secret from the app overview.

Configure

import { createKavach, oauth } from 'kavachos';
import { spotifyProvider } from 'kavachos/auth'; 

const kavach = await createKavach({
  database: { provider: 'sqlite', url: 'kavach.db' },
  plugins: [
    oauth({
      providers: [
        spotifyProvider( 
          process.env.SPOTIFY_CLIENT_ID, 
          process.env.SPOTIFY_CLIENT_SECRET, 
        ), 
      ],
    }),
  ],
});

Environment variables

SPOTIFY_CLIENT_ID=your_client_id
SPOTIFY_CLIENT_SECRET=your_client_secret

Scopes

Default scopes: user-read-email, user-read-private

To access additional Spotify data, pass a scopes array:

spotifyProvider(
  process.env.SPOTIFY_CLIENT_ID,
  process.env.SPOTIFY_CLIENT_SECRET,
  { scopes: ['user-read-email', 'user-read-private', 'user-library-read'] }, 
)

The user-read-email scope is required to retrieve the user's email address. Without it, the identity will fall back to the Spotify user ID.

Endpoints

Method	Path	Description
GET	`/auth/oauth/authorize/spotify`	Redirect to Spotify
GET	`/auth/oauth/callback/spotify`	Handle callback

Spotify