Clerk Auth - Breaking Changes & Error Prevention Guide
Package Versions: @clerk/nextjs@6.36.7, @clerk/backend@2.29.2, @clerk/clerk-react@5.59.2, @clerk/testing@1.13.26
Breaking Changes: Nov 2025 - API version 2025-11-10, Oct 2024 - Next.js v6 async auth()
Last Updated: 2026-01-09
What's New (Dec 2025 - Jan 2026)
1. API Keys Beta (Dec 11, 2025) - NEW ✨
User-scoped and organization-scoped API keys for your application. Zero-code UI component.
typescript
// 1. Add the component for self-service API key management
import { APIKeys } from '@clerk/nextjs'
export default function SettingsPage() {
return (
<div>
<h2>API Keys</h2>
<APIKeys /> {/* Full CRUD UI for user's API keys */}
</div>
)
}
Backend Verification:
typescript
import { verifyToken } from '@clerk/backend'
// API keys are verified like session tokens
const { data, error } = await verifyToken(apiKey, {
secretKey: process.env.CLERK_SECRET_KEY,
authorizedParties: ['https://yourdomain.com'],
})
// Check token type
if (data?.tokenType === 'api_key') {
// Handle API key auth
}
clerkMiddleware Token Types:
typescript
// v6.36.0+: Middleware can distinguish token types
clerkMiddleware((auth, req) => {
const { userId, tokenType } = auth()
if (tokenType === 'api_key') {
// API key auth - programmatic access
} else if (tokenType === 'session_token') {
// Regular session - web UI access
}
})
Pricing (Beta = Free):
- Creation: $0.001/key
- Verification: $0.0001/verification
2. Next.js 16: proxy.ts Middleware Filename (Dec 2025)
⚠️ BREAKING: Next.js 16 changed middleware filename due to critical security vulnerability (CVE disclosed March 2025).
Background: The March 2025 vulnerability (affecting Next.js 11.1.4-15.2.2) allowed attackers to completely bypass middleware-based authorization by adding a single HTTP header:
x-middleware-subrequest: true
. This affected all auth libraries (NextAuth, Clerk, custom solutions).
Why the Rename: The
→
change isn't just cosmetic - it's Next.js signaling that middleware-first security patterns are dangerous. Future auth implementations should not rely solely on middleware for authorization.
Next.js 15 and earlier: middleware.ts
Next.js 16+: proxy.ts
Correct Setup for Next.js 16:
typescript
// src/proxy.ts (NOT middleware.ts!)
import { clerkMiddleware } from '@clerk/nextjs/server'
export default clerkMiddleware()
export const config = {
matcher: [
'/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)',
'/(api|trpc)(.*)',
],
}
Minimum Version: @clerk/nextjs@6.35.0+ required for Next.js 16 (fixes Turbopack build errors and cache invalidation on sign-out).
3. Force Password Reset (Dec 19, 2025)
Administrators can mark passwords as compromised and force reset:
typescript
import { clerkClient } from '@clerk/backend'
// Force password reset for a user
await clerkClient.users.updateUser(userId, {
passwordDigest: 'compromised', // Triggers reset on next sign-in
})
4. Organization Reports & Filters (Dec 15-17, 2025)
Dashboard now includes org creation metrics and filtering by name/slug/date.
API Version 2025-11-10 Breaking Changes
1. API Version 2025-11-10 (Nov 10, 2025) - BREAKING CHANGES ⚠️
Affects: Applications using Clerk Billing/Commerce APIs
Critical Changes:
-
Endpoint URLs: →
(30+ endpoints)
GET /v1/commerce/plans → GET /v1/billing/plans
GET /v1/commerce/statements → GET /v1/billing/statements
POST /v1/me/commerce/checkouts → POST /v1/me/billing/checkouts
-
typescript
// OLD (deprecated)
{ payment_source_id: "...", payment_source: {...} }
// NEW (required)
{ payment_method_id: "...", payment_method: {...} }
-
Removed Fields: Plans responses no longer include:
- , (use instead)
- , (use fee objects)
- (use )
- ,
-
Removed Endpoints:
- Invoices endpoint (use statements)
- Products endpoint
-
Null Handling: Explicit rules -
means "doesn't exist", omitted means "not asserting existence"
Migration: Update SDK to v6.35.0+ which includes support for API version 2025-11-10.
2. Next.js v6 Async auth() (Oct 2024) - BREAKING CHANGE ⚠️
Affects: All Next.js Server Components using
typescript
// ❌ OLD (v5 - synchronous)
const { userId } = auth()
// ✅ NEW (v6 - asynchronous)
const { userId } = await auth()
Also affects: is now async in middleware
typescript
// ❌ OLD (v5)
auth.protect()
// ✅ NEW (v6)
await auth.protect()
Compatibility: Next.js 15, 16 supported. Static rendering by default.
3. PKCE Support for Custom OAuth (Nov 12, 2025)
Custom OIDC providers and social connections now support PKCE (Proof Key for Code Exchange) for enhanced security in native/mobile applications where client secrets cannot be safely stored.
Use case: Mobile apps, native apps, public clients that can't securely store secrets.
4. Client Trust: Credential Stuffing Defense (Nov 14, 2025)
Automatic secondary authentication when users sign in from unrecognized devices:
- Activates for users with valid passwords but no 2FA
- No configuration required
- Included in all Clerk plans
How it works: Clerk automatically prompts for additional verification (email code, backup code) when detecting sign-in from new device.
5. Next.js 16 Support (Nov 2025)
@clerk/nextjs v6.35.2+ includes cache invalidation improvements for Next.js 16 during sign-out.
Critical Patterns & Error Prevention
Next.js v6: Async auth() Helper
Pattern:
typescript
import { auth } from '@clerk/nextjs/server'
export default async function Page() {
const { userId } = await auth() // ← Must await
if (!userId) {
return <div>Unauthorized</div>
}
return <div>User ID: {userId}</div>
}
Cloudflare Workers: authorizedParties (CSRF Prevention)
CRITICAL: Always set
to prevent CSRF attacks
typescript
import { verifyToken } from '@clerk/backend'
const { data, error } = await verifyToken(token, {
secretKey: c.env.CLERK_SECRET_KEY,
// REQUIRED: Prevent CSRF attacks
authorizedParties: ['https://yourdomain.com'],
})
Why: Without
, attackers can use valid tokens from other domains.
clerkMiddleware() Configuration
Route Protection Patterns
typescript
import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server'
// Define protected routes
const isProtectedRoute = createRouteMatcher([
'/dashboard(.*)',
'/api/private(.*)',
])
const isAdminRoute = createRouteMatcher(['/admin(.*)'])
export default clerkMiddleware(async (auth, req) => {
// Protect routes
if (isProtectedRoute(req)) {
await auth.protect() // Redirects unauthenticated users
}
// Require specific permissions
if (isAdminRoute(req)) {
await auth.protect({
role: 'org:admin', // Requires organization admin role
})
}
})
All Middleware Options
| Option | Type | Description |
|---|
| | Enable debug logging |
| | JWKS public key for networkless verification |
| | Token time variance (default: 5000ms) |
| | URL-based org activation |
| | Custom sign-in URL |
| | Custom sign-up URL |
Organization Sync (URL-based Org Activation)
⚠️ Next.js Only: This feature currently only works with
in Next.js. It does NOT work with
in other runtimes (Cloudflare Workers, Express, etc.) due to
header checks.
typescript
clerkMiddleware({
organizationSyncOptions: {
organizationPatterns: ['/orgs/:slug', '/orgs/:slug/(.*)'],
personalAccountPatterns: ['/personal', '/personal/(.*)'],
},
})
Webhooks
Webhook Verification
typescript
import { Webhook } from 'svix'
export async function POST(req: Request) {
const payload = await req.text()
const headers = {
'svix-id': req.headers.get('svix-id')!,
'svix-timestamp': req.headers.get('svix-timestamp')!,
'svix-signature': req.headers.get('svix-signature')!,
}
const wh = new Webhook(process.env.CLERK_WEBHOOK_SIGNING_SECRET!)
try {
const event = wh.verify(payload, headers)
// Process event
return Response.json({ success: true })
} catch (err) {
return Response.json({ error: 'Invalid signature' }, { status: 400 })
}
}
Common Event Types
| Event | Trigger |
|---|
| New user signs up |
| User profile changes |
| User account deleted |
| New sign-in |
| Sign-out |
| New org created |
organization.membership.created
| User joins org |
⚠️ Important: Webhook routes must be PUBLIC (no auth). Add to middleware exclude list:
typescript
const isPublicRoute = createRouteMatcher([
'/api/webhooks/clerk(.*)', // Clerk webhooks are public
])
clerkMiddleware((auth, req) => {
if (!isPublicRoute(req)) {
auth.protect()
}
})
UI Components Quick Reference
| Component | Purpose |
|---|
| Full sign-in flow |
| Full sign-up flow |
| Trigger sign-in modal |
| Trigger sign-up modal |
| Render only when authenticated |
| Render only when unauthenticated |
| User menu with sign-out |
| Full profile management |
| Switch between orgs |
| Org settings |
| Create new org |
| API key management (NEW) |
React Hooks
| Hook | Returns |
|---|
| { userId, sessionId, isLoaded, isSignedIn, getToken }
|
| { user, isLoaded, isSignedIn }
|
| Clerk instance with methods |
| Current session object |
| Current org context |
| All user's orgs |
JWT Templates - Size Limits & Shortcodes
JWT Size Limitation: 1.2KB for Custom Claims ⚠️
Problem: Browser cookies limited to 4KB. Clerk's default claims consume ~2.8KB, leaving 1.2KB for custom claims.
⚠️ Development Note: When testing custom JWT claims in Vite dev mode, you may encounter
"431 Request Header Fields Too Large" error. This is caused by Clerk's handshake token in the URL exceeding Vite's 8KB limit. See
Issue #11 for solution.
Solution:
json
// ✅ GOOD: Minimal claims
{
"user_id": "{{user.id}}",
"email": "{{user.primary_email_address}}",
"role": "{{user.public_metadata.role}}"
}
// ❌ BAD: Exceeds limit
{
"bio": "{{user.public_metadata.bio}}", // 6KB field
"all_metadata": "{{user.public_metadata}}" // Entire object
}
Best Practice: Store large data in database, include only identifiers/roles in JWT.
Available Shortcodes Reference
| Category | Shortcodes | Example |
|---|
| User ID & Name | , , , | |
| Contact | {{user.primary_email_address}}
, {{user.primary_phone_address}}
| |
| Profile | , , | |
| Verification | , {{user.phone_number_verified}}
| |
| Metadata | , {{user.public_metadata.FIELD}}
| |
| Organization | , , (in sessionClaims) | |
Advanced Features:
- String Interpolation:
"{{user.last_name}} {{user.first_name}}"
- Conditional Fallbacks:
"{{user.public_metadata.role || 'user'}}"
- Nested Metadata:
"{{user.public_metadata.profile.interests}}"
Testing with Clerk
Test Credentials (Fixed OTP: 424242)
Test Emails (no emails sent, fixed OTP):
john+clerk_test@example.com
jane+clerk_test@gmail.com
Test Phone Numbers (no SMS sent, fixed OTP):
+12015550100
+19735550133
Fixed OTP Code:
(works for all test credentials)
Generate Session Tokens (60-second lifetime)
Script (
scripts/generate-session-token.js
):
bash
# Generate token
CLERK_SECRET_KEY=sk_test_... node scripts/generate-session-token.js
# Create new test user
CLERK_SECRET_KEY=sk_test_... node scripts/generate-session-token.js --create-user
# Auto-refresh token every 50 seconds
CLERK_SECRET_KEY=sk_test_... node scripts/generate-session-token.js --refresh
Manual Flow:
- Create user:
- Create session:
- Generate token:
POST /v1/sessions/{session_id}/tokens
- Use in header:
Authorization: Bearer <token>
E2E Testing with Playwright
Install
for automatic Testing Token management:
bash
npm install -D @clerk/testing
typescript
import { clerkSetup } from '@clerk/testing/playwright'
import { test as setup } from '@playwright/test'
setup('global setup', async ({}) => {
await clerkSetup()
})
typescript
import { setupClerkTestingToken } from '@clerk/testing/playwright'
import { test } from '@playwright/test'
test('sign up', async ({ page }) => {
await setupClerkTestingToken({ page })
await page.goto('/sign-up')
await page.fill('input[name="emailAddress"]', 'test+clerk_test@example.com')
await page.fill('input[name="password"]', 'TestPassword123!')
await page.click('button[type="submit"]')
// Verify with fixed OTP
await page.fill('input[name="code"]', '424242')
await page.click('button[type="submit"]')
await expect(page).toHaveURL('/dashboard')
})
Known Issues Prevention
This skill prevents 15 documented issues:
Issue #1: Missing Clerk Secret Key
Error: "Missing Clerk Secret Key or API Key"
Source:
https://stackoverflow.com/questions/77620604
Prevention: Always set in
or via
Issue #2: API Key → Secret Key Migration
Error: "apiKey is deprecated, use secretKey"
Source:
https://clerk.com/docs/upgrade-guides/core-2/backend
Prevention: Replace
with
in all calls
Issue #3: JWKS Cache Race Condition
Error: "No JWK available"
Source:
https://github.com/clerk/javascript/blob/main/packages/backend/CHANGELOG.md
Prevention: Use @clerk/backend@2.17.2 or later (fixed)
Issue #4: Missing authorizedParties (CSRF)
Error: No error, but CSRF vulnerability
Source:
https://clerk.com/docs/reference/backend/verify-token
Prevention: Always set
authorizedParties: ['https://yourdomain.com']
Issue #5: Import Path Changes (Core 2)
Error: "Cannot find module"
Source:
https://clerk.com/docs/upgrade-guides/core-2/backend
Prevention: Update import paths for Core 2
Issue #6: JWT Size Limit Exceeded
Error: Token exceeds size limit
Source:
https://clerk.com/docs/backend-requests/making/custom-session-token
Prevention: Keep custom claims under 1.2KB
Issue #7: Deprecated API Version v1
Error: "API version v1 is deprecated"
Source:
https://clerk.com/docs/upgrade-guides/core-2/backend
Prevention: Use latest SDK versions (API v2025-11-10)
Issue #8: ClerkProvider JSX Component Error
Error: "cannot be used as a JSX component"
Source:
https://stackoverflow.com/questions/79265537
Prevention: Ensure React 19 compatibility with @clerk/clerk-react@5.59.2+
Issue #9: Async auth() Helper Confusion
Error: "auth() is not a function"
Source:
https://clerk.com/changelog/2024-10-22-clerk-nextjs-v6
Prevention: Always await:
const { userId } = await auth()
Issue #10: Environment Variable Misconfiguration
Error: "Missing Publishable Key" or secret leaked
Prevention: Use correct prefixes (
,
), never commit secrets
Issue #11: 431 Request Header Fields Too Large (Vite Dev Mode)
Error: "431 Request Header Fields Too Large" when signing in
Source: Common in Vite dev mode when testing custom JWT claims
Cause: Clerk's
token in URL exceeds Vite's 8KB header limit
Prevention:
json
{
"scripts": {
"dev": "NODE_OPTIONS='--max-http-header-size=32768' vite"
}
}
Temporary Workaround: Clear browser cache, sign out, sign back in
Why: Clerk dev tokens are larger than production; custom JWT claims increase handshake token size
Note: This is different from Issue #6 (session token size). Issue #6 is about cookies (1.2KB), this is about URL parameters in dev mode (8KB → 32KB).
Issue #12: User Type Mismatch (useUser vs currentUser)
Error: TypeScript errors when sharing user utilities across client/server
Source:
GitHub Issue #2176
Why It Happens:
returns
(client-side) with different properties than
returns
(server-side). Client has
,
object; server has
and
instead.
Prevention: Use shared properties only, or create separate utility functions for client vs server contexts.
typescript
// ✅ CORRECT: Use properties that exist in both
const primaryEmailAddress = user.emailAddresses.find(
({ id }) => id === user.primaryEmailAddressId
)
// ✅ CORRECT: Separate types
type ClientUser = ReturnType<typeof useUser>['user']
type ServerUser = Awaited<ReturnType<typeof currentUser>>
Issue #13: Multiple acceptsToken Types Causes token-type-mismatch
Error: "token-type-mismatch" when using
with multiple token types
Source:
GitHub Issue #7520
Why It Happens: When using
with multiple
values (e.g.,
['session_token', 'api_key']
), Clerk incorrectly throws token-type-mismatch error.
Prevention: Upgrade to @clerk/backend@2.29.2+ (fix available in snapshot, releasing soon).
typescript
// This now works in @clerk/backend@2.29.2+
const result = await authenticateRequest(request, {
acceptsToken: ['session_token', 'api_key'], // Fixed!
})
Issue #14: deriveUrlFromHeaders Server Crash on Malformed URLs
Error: Server crashes with URL parsing error
Source:
GitHub Issue #7275
Why It Happens: Internal
function performs unsafe URL parsing and crashes the entire server when receiving malformed URLs in headers (e.g.,
x-forwarded-host: 'example.com[invalid]'
). This is a denial-of-service vulnerability.
Prevention: Upgrade to @clerk/backend@2.29.0+ (fixed).
Issue #15: treatPendingAsSignedOut Option for Pending Sessions
Error: None - optional parameter for edge case handling
Source:
Changelog @clerk/nextjs@6.32.0
Why It Exists: Sessions can have a
status during certain flows (e.g., credential stuffing defense secondary auth). By default, pending sessions are treated as signed-out (user is null).
Usage: Set
treatPendingAsSignedOut: false
to treat pending as signed-in (available in @clerk/nextjs@6.32.0+).
typescript
// Default: pending = signed out
const user = await currentUser() // null if status is 'pending'
// Treat pending as signed in
const user = await currentUser({ treatPendingAsSignedOut: false }) // defined if pending
Production Considerations
Service Availability & Reliability
Context: Clerk experienced 3 major service disruptions in May-June 2025 attributed to Google Cloud Platform (GCP) outages. The June 26, 2025 outage lasted 45 minutes (6:16-7:01 UTC) and affected all Clerk customers.
Mitigation Strategies:
- Monitor Clerk Status for real-time updates
- Implement graceful degradation when Clerk API is unavailable
- Cache auth tokens locally where possible
- For existing sessions, use option for networkless verification:
typescript
clerkMiddleware({
jwtKey: process.env.CLERK_JWT_KEY, // Allows offline token verification
})
Note: During total outage, no new sessions can be created (auth requires Clerk API). However, existing sessions can continue working if you verify JWTs locally with
. Clerk committed to exploring multi-cloud redundancy to reduce single-vendor dependency risk.
Official Documentation
Package Versions
Latest (Nov 22, 2025):
json
{
"dependencies": {
"@clerk/nextjs": "^6.36.7",
"@clerk/clerk-react": "^5.59.2",
"@clerk/backend": "^2.29.2",
"@clerk/testing": "^1.13.26"
}
}
Token Efficiency:
- Without skill: ~6,500 tokens (setup tutorials, JWT templates, testing setup, webhooks, production considerations)
- With skill: ~3,200 tokens (breaking changes + critical patterns + error prevention + production guidance)
- Savings: ~51% (~3,300 tokens)
Errors prevented: 15 documented issues with exact solutions
Key value: API Keys beta, Next.js 16 proxy.ts (with March 2025 CVE context), clerkMiddleware() options, webhooks, component reference, API 2025-11-10 breaking changes, JWT size limits, user type mismatches, production considerations (GCP outages, jwtKey offline verification)
Last verified: 2026-01-20 | Skill version: 3.1.0 | Changes: Added 4 new Known Issues (#12-15: user type mismatch, acceptsToken type mismatch, deriveUrlFromHeaders crash, treatPendingAsSignedOut option), expanded proxy.ts section with March 2025 CVE security context, added Production Considerations section (GCP outages + mitigation), added organizationSyncOptions Next.js-only limitation note, updated minimum version requirements for Next.js 16 (6.35.0+).