Discord

Discord OAuth2

Authorization Code Exchange for web and mobile — Discord application setup, API reference, and frontend examples.

Overview

Discord login is optional and controlled by DISCORD_AUTH_ENABLED. When disabled, Discord endpoints return 503 Service Unavailable. JWTs are never placed in the redirect URL; the API issues a one-time exchangeCode (Redis, 60 seconds). The same POST /auth/exchange endpoint is shared with other social providers.

  • • Feature-flagged via environment
  • • Custom passport-oauth2 strategy + DiscordAuthGuard
  • • Profile fetched via GET https://discord.com/api/users/@me after token exchange
  • • Scopes identify and email for profile and email
  • • Redirect allowlist prevents open redirects
  • • Same token response shape as POST /auth/login

Discord Applications

Create an application under Discord Developer Portal → Applications, open OAuth2, and set the Redirect URI to match DISCORD_CALLBACK_URL. Enable the identify and email scopes.

  1. Open Discord Developer Portal → Applications
  2. Create a new application (or select an existing one)
  3. Go to OAuth2
  4. Add a Redirect URI (e.g. http://localhost:3000/api/v1/auth/discord/callback)
  5. Enable the identify and email scopes
  6. Copy Client ID and Client Secret into your .env
  7. Ensure DISCORD_CALLBACK_URL matches the Redirect URI registered in Discord

Environment variables

Loaded from .env via src/config/discord-oauth.config.ts (namespace discordOAuth on ConfigService). See .env.example.

Environment.env
DISCORD_AUTH_ENABLED=true
DISCORD_CLIENT_ID=your-discord-application-id
DISCORD_CLIENT_SECRET=your-discord-client-secret
DISCORD_CALLBACK_URL=http://localhost:3000/api/v1/auth/discord/callback
DISCORD_REDIRECT_ALLOWLIST=myapp://success,http://localhost:5173/auth/callback
DISCORD_OAUTH_DEFAULT_ROLES=

Default roles for new Discord users

New Discord users receive roles: [] by default (same as password register). Set DISCORD_OAUTH_DEFAULT_ROLES in .env to a comma-separated list of Role values (e.g. user or user,manager). Existing users linked by email keep their current roles.

Sequence

  1. Client opens GET /api/v1/auth/discord?redirect=<allowlisted URL>
  2. User consents on Discord; browser hits GET /api/v1/auth/discord/callback
  3. API calls GET https://discord.com/api/users/@me, upserts user, stores exchangeCode in Redis, redirects to redirect?code=...
  4. Client POSTs { code } to /api/v1/auth/exchange and receives JWTs

API reference

1. Start OAuth

Opens Discord consent at https://discord.com/api/oauth2/authorize. Query redirect must match a prefix in DISCORD_REDIRECT_ALLOWLIST (or omit to use the first allowlist entry). Scopes: identify email.

HTTPGET /api/v1/auth/discord
GET /api/v1/auth/discord?redirect=http%3A%2F%2Flocalhost%3A5173%2Fauth%2Fcallback

400 invalid redirect · 503 feature disabled

2. Callback

Handled by the API. Token exchange uses https://discord.com/api/oauth2/token. Redirects to your app with ?code= (or &code= if the URL already has a query).

HTTPGET /api/v1/auth/discord/callback
GET /api/v1/auth/discord/callback?code=DISCORD_AUTH_CODE&state=...
→ 302 Location: http://localhost:5173/auth/callback?code=EXCHANGE_CODE

3. Exchange code

Public endpoint shared with other social providers. Consumes the code (single use) and returns the same shape as login.

HTTP RequestPOST /api/v1/auth/exchange
POST /api/v1/auth/exchange
Content-Type: application/json

{
  "code": "EXCHANGE_CODE"
}
HTTP Response200 OK
{
  "user": {
    "id": "...",
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Doe",
    "roles": [],
    "discordId": "123456789012345678",
    "isActive": true
  },
  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIs..."
}

401 invalid/expired/used code · 503 social auth disabled

Frontend — Web (SPA)

Typical flow: button starts OAuth in the same window (or popup); a callback route on your frontend origin reads code from the query string and calls exchange.

JavaScriptStart Discord login
const API = 'http://localhost:3000/api/v1';
const redirect = encodeURIComponent(
  'http://localhost:5173/auth/callback'
);

// Full-page redirect to Nest → Discord → back to SPA
window.location.href = `${API}/auth/discord?redirect=${redirect}`;
JavaScriptCallback page /auth/callback
// /auth/callback on the SPA
const params = new URLSearchParams(window.location.search);
const code = params.get('code');
if (!code) throw new Error('Missing exchange code');

const res = await fetch('http://localhost:3000/api/v1/auth/exchange', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ code }),
});
if (!res.ok) throw new Error(await res.text());

const { user, accessToken, refreshToken } = await res.json();
// persist tokens as your app requires
sessionStorage.setItem('accessToken', accessToken);
console.log('signed in', user.email);
  • • Add your frontend callback URL to DISCORD_REDIRECT_ALLOWLIST (e.g. http://localhost:5173/auth/callback)
  • • DISCORD_CALLBACK_URL must point at the Nest API, not the SPA
  • • Store accessToken / refreshToken securely (memory + httpOnly cookie patterns as you prefer)

Frontend — Mobile (deep link)

Use a custom scheme (or universal link) in the allowlist. After Discord, the API redirects to myapp://success?code=.... The app opens, parses the code, and calls exchange.

React NativeOpen OAuth in browser
import * as Linking from 'expo-linking';
import * as WebBrowser from 'expo-web-browser';

const API = 'https://api.example.com/api/v1';
const redirect = encodeURIComponent('myapp://success');

async function signInWithDiscord() {
  const url = `${API}/auth/discord?redirect=${redirect}`;
  await WebBrowser.openAuthSessionAsync(url, 'myapp://success');
}
React NativeHandle deep link + exchange
import * as Linking from 'expo-linking';

async function exchangeFromUrl(url) {
  const { queryParams } = Linking.parse(url);
  const code = queryParams?.code;
  if (!code) return;

  const res = await fetch(`${API}/auth/exchange`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ code }),
  });
  const data = await res.json();
  // data.accessToken, data.refreshToken, data.user
  return data;
}

Linking.addEventListener('url', ({ url }) => {
  exchangeFromUrl(url);
});
  • • Register the scheme in the OS / Expo app.json
  • • Prefer Linking.addEventListener('url', ...) and getInitialURL()
  • • Exchange over HTTPS against your API base URL

Security notes

  • • Redirect URLs must match DISCORD_REDIRECT_ALLOWLIST prefixes
  • • Exchange codes are single-use and expire in 60 seconds (Redis)
  • • Existing local users are linked by verified Discord email (discordId set; roles unchanged)
  • • Discord-only users have password null — password login / change-password will fail until a password is set
  • • Email is required from discord.com/api/users/@me; login fails if Discord does not return an email (scopes identify and email)

User model

Postgres entity / interface fields used by Discord login:

  • • discordId — unique nullable Discord user snowflake (id from /users/@me)
  • • password — nullable for OAuth-only accounts
  • • isActive — set true for new Discord users
  • • roles — from DISCORD_OAUTH_DEFAULT_ROLES env (default [])

Related