Server: AuthError

Thrown when authentication or authorization fails.

Carries an HTTP status code suitable for returning directly in a response (401 when the request's credentials are at fault, 500 when the server is misconfigured and could not have authenticated anyone).

Parameters

• source

  (Required)

  Always `"@supabase/server"`.

• code

  (Required)

  Machine-readable error code.

• hint

  (Optional)

  Actionable next step, when one applies.

• docs

  (Required)

  Documentation URL for this error's `code`.

• details

  (Optional)

  Structured, non-sensitive diagnostics — accepted auth modes, which credential headers were present, configured key *names*, JWT header fields. Never key values or token payloads.

• status

  (Required)

  HTTP status code. - `401` — The request's credentials are at fault (MissingCredentialsError, InvalidApiKeyError, InvalidJwtError). - `500` — The server is misconfigured (JwksNotConfiguredError, NoKeysConfiguredError, JwksFetchFailedError, CreateSupabaseClientError).

Examples

Catching an AuthError

import { createSupabaseContext } from '@supabase/server'

const { data: ctx, error } = await createSupabaseContext(request, { auth: 'user' })
if (error) {
  // error is an AuthError — `toJSON()` includes source, code, message, hint, docs, details
  return Response.json(error.toJSON(), { status: error.status })
}