forbidden

この機能は現在実験的であり、変更される可能性があります。本番環境での使用は推奨されません。お試しいただき、GitHubでフィードバックをお寄せください。

forbidden 関数はエラーをスローし、Next.js の 403 エラーページを表示します。アプリケーションでの認可エラーの処理に役立ちます。forbidden.js ファイルを使用して UI をカスタマイズできます。

forbidden を使用するには、next.config.js ファイルで実験的な authInterrupts 設定オプションを有効にしてください。

import type { NextConfig } from 'next'
 
const nextConfig: NextConfig = {
  experimental: {
    authInterrupts: true,
  },
}
 
export default nextConfig

forbidden は、Server Components、Server Actions、および Route Handlers で呼び出すことができます。

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 <></>
}

Good to know

forbidden 関数は、ルートレイアウトでは呼び出すことができません。

例

ロールベースのルート保護

forbidden を使用すると、ユーザーのロールに基づいて特定のルートへのアクセスを制限できます。これにより、認証済みであっても必要な権限を持たないユーザーがルートにアクセスできないようにします。

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>
  )
}

Server Actions を使用したミューテーション

Server Actions でミューテーションを実装する場合、forbidden を使用して、特定のロールを持つユーザーのみが機密データを更新できるようにすることができます。

'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
  // ...
}

バージョン履歴

バージョン	変更履歴
`v15.1.0`	`forbidden` が導入されました。

次のステップ

forbidden.js

forbidden.js 特殊ファイルの API リファレンス。