This feature is currently experimental and subject to change, it’s not recommended for production. Try it out and share your feedback on GitHub.
forbidden
The forbidden function throws an error that renders a Next.js 403 error page. It's useful for handling authorization errors in your application. You can customize the UI using the forbidden.js file.
To start using forbidden, enable the experimental authInterrupts configuration option in your next.config.js file:
TypeScript
next.config.ts
import type { NextConfig } from 'next'const nextConfig: NextConfig = { experimental: { authInterrupts: true, },}export default nextConfig
import { verifySession } from '@/app/lib/dal'import { forbidden } from 'next/navigation'export default async function AdminPage() { const session = await verifySession() // Check if the user has the 'admin' role if (session.role !== 'admin') { forbidden() } // Render the admin page for authorized users return <></>}
You can use forbidden to restrict access to certain routes based on user roles. This ensures that users who are authenticated but lack the required permissions cannot access the route.
TypeScript
app/admin/page.tsx
import { verifySession } from '@/app/lib/dal'import { forbidden } from 'next/navigation'export default async function AdminPage() { const session = await verifySession() // Check if the user has the 'admin' role if (session.role !== 'admin') { forbidden() } // Render the admin page for authorized users return ( <main> <h1>Admin Dashboard</h1> <p>Welcome, {session.user.name}!</p> </main> )}
When implementing mutations in Server Actions, you can use forbidden to only allow users with a specific role to update sensitive data.
TypeScript
app/actions/update-role.ts
'use server'import { verifySession } from '@/app/lib/dal'import { forbidden } from 'next/navigation'import db from '@/app/lib/db'export async function updateRole(formData: FormData) { const session = await verifySession() // Ensure only admins can update roles if (session.role !== 'admin') { forbidden() } // Perform the role update for authorized users // ...}