Menu

forbidden

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

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

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

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

app/auth/page.tsx
TypeScript
import { verifySession } from '@/app/lib/dal'
import { forbidden } from 'next/navigation'
 
export default async function AdminPage() {
  const session = await verifySession()
 
  // ユーザーが'admin'ロールを持っているか確認
  if (session.role !== 'admin') {
    forbidden()
  }
 
  // 認可されたユーザーに管理ページを表示
  return <></>
}

補足

例

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

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

app/admin/page.tsx
TypeScript
import { verifySession } from '@/app/lib/dal'
import { forbidden } from 'next/navigation'
 
export default async function AdminPage() {
  const session = await verifySession()
 
  // ユーザーが'admin'ロールを持っているか確認
  if (session.role !== 'admin') {
    forbidden()
  }
 
  // 認可されたユーザーに管理ページを表示
  return (
    <main>
      <h1>管理者ダッシュボード</h1>
      <p>ようこそ、{session.user.name}さん！</p>
    </main>
  )
}

Server Actionsでのミューテーション

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

app/actions/update-role.ts
TypeScript
'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()
 
  // 管理者のみがロールを更新できるようにする
  if (session.role !== 'admin') {
    forbidden()
  }
 
  // 認可されたユーザーのロール更新を実行
  // ...
}

バージョン履歴

バージョン変更内容
v15.1.0導入時期：forbidden関数

下一步

forbidden.js

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