unauthorized

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

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

next.config.ts

TypeScript

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

unauthorizedはServer Components、Server Actions、Route Handlersで呼び出せます。

app/dashboard/page.tsx

TypeScript

import { verifySession } from '@/app/lib/dal'
import { unauthorized } from 'next/navigation'
 
export default async function DashboardPage() {
  const session = await verifySession()
 
  if (!session) {
    unauthorized()
  }
 
  // 認証済みユーザー向けのダッシュボードをレンダリング
  return (
    <main>
      <h1>ダッシュボードへようこそ</h1>
      <p>こんにちは、{session.user.name}さん。</p>
    </main>
  )
}

補足

unauthorized関数はルートレイアウト内では呼び出せません。

例

未認証ユーザーにログインUIを表示

unauthorized関数を使用して、ログインUIを含むunauthorized.jsファイルを表示できます。

app/dashboard/page.tsx

TypeScript

import { verifySession } from '@/app/lib/dal'
import { unauthorized } from 'next/navigation'
 
export default async function DashboardPage() {
  const session = await verifySession()
 
  if (!session) {
    unauthorized()
  }
 
  return <div>Dashboard</div>
}

app/unauthorized.tsx

TypeScript

import Login from '@/app/components/Login'
 
export default function UnauthorizedPage() {
  return (
    <main>
      <h1>401 - 認可されていません</h1>
      <p>このページにアクセスするにはログインしてください。</p>
      <Login />
    </main>
  )
}

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

Server Actionsでunauthorizedを呼び出して、認証済みユーザーのみが特定のミューテーションを実行できるようにできます。

app/actions/update-profile.ts

TypeScript

'use server'
 
import { verifySession } from '@/app/lib/dal'
import { unauthorized } from 'next/navigation'
import db from '@/app/lib/db'
 
export async function updateProfile(data: FormData) {
  const session = await verifySession()
 
  // ユーザーが認証されていない場合は401を返す
  if (!session) {
    unauthorized()
  }
 
  // ミューテーションを実行
  // ...
}

Route Handlersでのデータ取得

Route Handlersでunauthorizedを使用して、認証済みユーザーのみがエンドポイントにアクセスできるようにできます。

app/api/profile/route.ts

TypeScript

import { NextRequest, NextResponse } from 'next/server'
import { verifySession } from '@/app/lib/dal'
import { unauthorized } from 'next/navigation'
 
export async function GET(req: NextRequest): Promise<NextResponse> {
  // ユーザーのセッションを検証
  const session = await verifySession()
 
  // セッションが存在しない場合は401を返してunauthorized.tsxをレンダリング
  if (!session) {
    unauthorized()
  }
 
  // データを取得
  // ...
}

バージョン履歴

バージョン	変更内容
`v15.1.0`	導入時期：`unauthorized`

unauthorized

補足

例

未認証ユーザーにログインUIを表示

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

Route Handlersでのデータ取得

バージョン履歴

下一步

unauthorized.js