unauthorized

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

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

import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  experimental: {
    authInterrupts: true,
  },
}

export default nextConfig

module.exports = {
  experimental: {
    authInterrupts: true,
  },
}

unauthorized はサーバーコンポーネント、サーバーアクション、ルートハンドラーで呼び出すことができます。

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

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 ファイルを表示できます。

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>ダッシュボード</div>
}

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>ダッシュボード</div>
}

import Login from '@/app/components/Login'

export default function UnauthorizedPage() {
  return (
    <main>
      <h1>401 - 認証が必要です</h1>
      <p>このページにアクセスするにはログインしてください。</p>
      <Login />
    </main>
  )
}

import Login from '@/app/components/Login'

export default function UnauthorizedPage() {
  return (
    <main>
      <h1>401 - 認証が必要です</h1>
      <p>このページにアクセスするにはログインしてください。</p>
      <Login />
    </main>
  )
}

サーバーアクションでの変更処理

サーバーアクションで unauthorized を呼び出し、認証済みユーザーのみが特定の変更を実行できるようにできます。

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

  // 変更処理を続行
  // ...
}

'use server'

import { verifySession } from '@/app/lib/dal'
import { unauthorized } from 'next/navigation'
import db from '@/app/lib/db'

export async function updateProfile(data) {
  const session = await verifySession()

  // ユーザーが認証されていない場合、401 を返す
  if (!session) {
    unauthorized()
  }

  // 変更処理を続行
  // ...
}

ルートハンドラーでのデータ取得

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

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

  // データを取得
  // ...
}

import { verifySession } from '@/app/lib/dal'
import { unauthorized } from 'next/navigation'

export async function GET() {
  const session = await verifySession()

  // ユーザーが認証されていない場合、401 を返して unauthorized.tsx をレンダリング
  if (!session) {
    unauthorized()
  }

  // データを取得
  // ...
}

バージョン履歴

バージョン	変更内容
`v15.1.0`	`unauthorized` が導入されました。

unauthorized.js

unauthorized.js 特殊ファイルに関する API リファレンス。