
express-oauth2-jwt-bearer
★ 37by auth0 · part of auth0/agent-skills
Use when adding Auth0 token validation to Express or Node.js APIs - integrates express-oauth2-jwt-bearer SDK to protect Node.js API endpoints with JWT Bearer…
Use when adding Auth0 token validation to Express or Node.js APIs - integrates express-oauth2-jwt-bearer SDK to protect Node.js API endpoints with JWT Bearer…
Inspect the full instructions your agent will receiveExpandCollapse
This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.
by auth0
Use when adding Auth0 token validation to Express or Node.js APIs - integrates express-oauth2-jwt-bearer SDK to protect Node.js API endpoints with JWT Bearer…
npx skills add https://github.com/auth0/agent-skills --skill express-oauth2-jwt-bearer
Download ZIPGitHub37
Node OAuth2 JWT Bearer Integration
The express-oauth2-jwt-bearer package provides Express middleware for validating Auth0 JWT Bearer access tokens. It handles token extraction, signature verification, audience and issuer validation, and expiry checks per RFC 6750 — letting you focus on business logic rather than JWT parsing.
Agent instruction: Before providing SDK setup instructions, fetch the latest release version by running:
gh api repos/auth0/node-oauth2-jwt-bearer/releases/latest --jq '.tag_name'
Use the returned version in all package.json dependency lines instead of any hardcoded version below.
When NOT to Use
Use Case Recommended Skill
Building a server-side web app with login UI (Express sessions) auth0-express
Building a Next.js app with server-side auth auth0-nextjs
Building a React/Angular/Vue SPA auth0-react, auth0-angular, auth0-vue
Building a React Native or mobile app auth0-react-native, auth0-android, auth0-swift
ASP.NET Core Web API auth0-aspnetcore-api
Go API with JWT middleware go-jwt-middleware
Python API (Flask/FastAPI) auth0-api-python
Node.js API using the older express-jwt package express-jwt
Detailed Documentation
-
Setup Guide — Auth0 API registration, .env configuration, bootstrap script for automated setup, and secret management
-
Integration Patterns — Protected endpoints, RBAC with scopes and claims, DPoP, CORS setup, error handling, and testing with curl
-
API Reference & Testing — Full configuration options, claims reference, complete code example, testing checklist, and common issues
Related Skills
-
auth0-express — For Express web apps with login UI (sessions, cookies)
-
auth0-nextjs — For Next.js server-side web apps
-
auth0-aspnetcore-api — BACKEND_API reference implementation for .NET
-
go-jwt-middleware — JWT middleware for Go APIs
-
auth0-api-python — JWT validation for Python APIs (Flask/FastAPI)
-
auth0-cli — Manage Auth0 resources from the terminal
Quick Reference
Core Middleware
Function Description Returns
auth(options?) JWT Bearer validation middleware Handler — 401 if token invalid/missing
requiredScopes(scopes) Validates token has all required scopes Handler — 403 if scopes missing
scopeIncludesAny(scopes) Validates token has at least one scope Handler — 403 if no match
claimEquals(claim, value) Validates a claim equals a value Handler — 401 if mismatch
claimIncludes(claim, ...values) Validates claim includes all values Handler — 401 if incomplete
claimCheck(fn, desc?) Custom claim validation function Handler — 401 if fn returns false
Configuration Options
Option Type Description
issuerBaseURL string Full issuer URL with https://. Optional — defaults to the ISSUER_BASE_URL env var
audience string API Identifier from Auth0 Dashboard. Optional — defaults to the AUDIENCE env var
tokenSigningAlg string Signing algorithm (default: RS256; use HS256 for symmetric)
authRequired boolean Set false to make authentication optional (default: true)
clockTolerance number Clock skew tolerance in seconds (no default; undefined unless set)
dpop DPoPOptions DPoP configuration (see integration.md)
Environment Variables
Variable Description
ISSUER_BASE_URL Full issuer URL with https://, e.g. https://your-tenant.us.auth0.com (auto-detected by SDK)
AUDIENCE API Identifier, e.g. https://your-api-identifier (auto-detected by SDK)
Request Object
After successful validation, req.auth contains:
req.auth.payload // Decoded JWT payload (sub, iss, aud, exp, permissions, etc.)
req.auth.header // JWT header (alg, typ, kid)
req.auth.token // Raw JWT string
SDK Architecture
The node-oauth2-jwt-bearer monorepo contains three packages:
Package Purpose
express-oauth2-jwt-bearer Main package. Express middleware for JWT Bearer validation. Published to npm.
access-token-jwt Low-level JWT verification utilities (used internally).
oauth2-bearer RFC 6750 Bearer token extraction (used internally).
In practice, you only install and import express-oauth2-jwt-bearer.
Auth Flow Comparison
Auth Pattern SDK When to Use
JWT Bearer (stateless) express-oauth2-jwt-bearer APIs called by SPAs, mobile apps, M2M clients
Session-based (stateful) @auth0/express-openid-connect Web apps with login UI and server-side sessions
Testing Quick Reference
# Get test token from Auth0 Dashboard → APIs → your API → Test tab
# Copy the token, then:
# 1. Verify 401 on protected route (no token)
curl -v http://localhost:3000/api/private
# 2. Verify 200 with valid token
curl -H "Authorization: Bearer " http://localhost:3000/api/private
# 3. Verify 403 with valid token but missing scope
curl -H "Authorization: Bearer " http://localhost:3000/api/admin
# 4. Verify CORS preflight
curl -v -X OPTIONS http://localhost:3000/api/private \
-H "Origin: http://localhost:5173" \
-H "Access-Control-Request-Method: GET" \
-H "Access-Control-Request-Headers: Authorization"
References
npm install express-oauth2-jwt-bearerRun this in your project — your agent picks the skill up automatically.
Prerequisites
-
Node.js 18+ (20+ recommended; required for bootstrap script automation)
-
Express 4.x or 5.x
-
npm or yarn
-
An Auth0 account with a configured API (Resource Server)
-
Auth0 CLI (for automatic setup):
npm install -g @auth0/auth0-cli
Quick Start Workflow
Agent instruction: Follow these steps to integrate express-oauth2-jwt-bearer into the user's Node.js API project.
Fetch latest version (see instruction above).
Install the SDK:
npm install express-oauth2-jwt-bearer
Configure Auth0 — follow references/setup.md. If the user already provided their Auth0 Domain and API Audience in the prompt, write them to a .env file as ISSUER_BASE_URL (the full issuer URL, including https://) and AUDIENCE — the SDK reads these automatically. Skip the bootstrap script and do NOT call AskUserQuestion to re-confirm. Never hardcode the domain or audience as literal strings (or || fallback defaults) in server.js / app.js — they belong in .env only. Otherwise, offer automatic setup via bootstrap script or manual setup.
Set up middleware — first create a .env file with the Auth0 values, then load it and add the middleware. express-oauth2-jwt-bearer reads ISSUER_BASE_URL and AUDIENCE from the environment automatically, so auth() needs no arguments:
# .env
ISSUER_BASE_URL=https://your-tenant.us.auth0.com
AUDIENCE=https://your-api-identifier
import 'dotenv/config'; // load .env before the SDK reads process.env
import { auth } from 'express-oauth2-jwt-bearer';
// Reads ISSUER_BASE_URL and AUDIENCE from the environment — no config needed
const checkJwt = auth();
app.use(checkJwt); // apply globally, or per-route
Keep the issuer and audience in .env — do not inline literal values or pass them as arguments here.
Protect endpoints — apply middleware globally or to specific routes:
// Global protection
app.use(checkJwt);
// Or per-route
app.get('/api/private', checkJwt, (req, res) => {
res.json({ sub: req.auth.payload.sub });
});
Add RBAC (optional) — use requiredScopes() or claimIncludes() for permission-based access:
import { auth, requiredScopes, claimIncludes } from 'express-oauth2-jwt-bearer';
app.get('/api/messages', checkJwt, requiredScopes('read:messages'), (req, res) => {
res.json({ messages: [] });
});
Important: requiredScopes accepts a single argument — a space-separated string or an array. Do NOT pass multiple string arguments: requiredScopes('read:msg', 'write:msg') silently ignores everything after the first. Use requiredScopes('read:msg write:msg') or requiredScopes(['read:msg', 'write:msg']) instead.
Verify the integration — build and test:
node server.js
curl http://localhost:3000/api/private # should return 401
curl -H "Authorization: Bearer " http://localhost:3000/api/private # should return 200
Failcheck: If the server fails to start or tokens are rejected unexpectedly, check references/api.md for common issues. After 5-6 failed iterations, use AskUserQuestion to ask the user for more details about their environment.
Common Mistakes
Mistake Symptom Fix
Created an Application instead of an API in Auth0 Dashboard Token validation fails; wrong audience Create a new API (Resource Server) in Auth0 Dashboard → APIs
Audience doesn't match API identifier exactly 401 Unauthorized — "Audience mismatch" Copy the exact API Identifier string from Auth0 Dashboard → APIs
ISSUER_BASE_URL missing the https:// scheme Error: Invalid URL at startup ISSUER_BASE_URL must be the full issuer URL: https://your-tenant.us.auth0.com
Checking scope claim instead of permissions for RBAC 403 always returned or permissions ignored Use requiredScopes() for scope-based RBAC; use claimIncludes('permissions', 'read:data') for Auth0 RBAC permission claims
CORS not configured before auth middleware Preflight OPTIONS requests return 401 Add cors() middleware before auth() in the middleware chain
.env file not loaded undefined for domain/audience Add import 'dotenv/config' at the top of the entry file
Hardcoded domain/audience in source (incl. process.env.X || 'literal' fallbacks) Secrets committed to source; fails security review Put values in .env (ISSUER_BASE_URL / AUDIENCE) and let auth() read them automatically — no literal fallbacks
req.auth is undefined TypeError: Cannot read properties of undefined Verify checkJwt middleware runs before the handler