Description: Documentation for @auth0/nextjs-auth0

# @auth0/nextjs-auth0 - v4.3.0

The Auth0 Next.js SDK is a library for implementing user authentication in Next.js applications.

📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback

## Documentation

- QuickStart- our guide for adding Auth0 to your Next.js app.
- Examples - lots of examples for your different use cases.
- Security - Some important security notices that you should check.
- Docs Site - explore our docs site and learn more about Auth0.

## Getting Started

### 1. Install the SDK

    npm i @auth0/nextjs-auth0

This library requires Node.js 20 LTS and newer LTS versions.

### 2. Add the environment variables

Add the following environment variables to your `.env.local` file:

    AUTH0_DOMAIN=
    AUTH0_CLIENT_ID=
    AUTH0_CLIENT_SECRET=
    AUTH0_SECRET=
    APP_BASE_URL=

The `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET` can be obtained from the Auth0 Dashboard once you've created an application. This application must be a `Regular Web Application`.

The `AUTH0_SECRET` is the key used to encrypt the session and transaction cookies. You can generate a secret using `openssl`:

    openssl rand -hex 32

The `APP_BASE_URL` is the URL that your application is running on. When developing locally, this is most commonly `http://localhost:3000`.

Important

You will need to register the follwing URLs in your Auth0 Application via the Auth0 Dashboard:

- Add `http://localhost:3000/auth/callback` to the list of Allowed Callback URLs
- Add `http://localhost:3000` to the list of Allowed Logout URLs

### 3. Create the Auth0 SDK client

Create an instance of the Auth0 client. This instance will be imported and used in anywhere we need access to the authentication methods on the server.

Add the following contents to a file named `lib/auth0.ts`:

    import { Auth0Client } from "@auth0/nextjs-auth0/server"

    export const auth0 = new Auth0Client()

### 4. Add the authentication middleware

Create a `middleware.ts` file in the root of your project's directory:

    import type { NextRequest } from "next/server"

    import { auth0 } from "./lib/auth0"

    export async function middleware(request: NextRequest) {
      return await auth0.middleware(request)
    }

    export const config = {
      matcher: [
        /*
         * Match all request paths except for the ones starting with:
         * - _next/static (static files)
         * - _next/image (image optimization files)
         * - favicon.ico, sitemap.xml, robots.txt (metadata files)
         */
        "/((?!_next/static|_next/image|favicon.ico|sitemap.xml|robots.txt).*)",
      ],
    }

Note

If you're using a `src/` directory, the `middleware.ts` file must be created inside the `src/` directory.

You can now begin to authenticate your users by redirecting them to your application's `/auth/login` route:

    import { auth0 } from "@/lib/auth0"

    export default async function Home() {
      const session = await auth0.getSession()

      if (!session) {
        return (
          <main>
            <a href="/auth/login?screen_hint=signup">Sign up</a>
            <a href="/auth/login">Log in</a>
          </main>
        )
      }

      return (
        <main>
          <h1>Welcome, {session.user.name}!</h1>
        </main>
      )
    }

Important

You must use `<a>` tags instead of the `<Link>` component to ensure that the routing is not done client-side as that may result in some unexpected behavior.

## Customizing the client

You can customize the client by using the options below:

Option | Type | Description
--- | --- | ---
domain | `string` | The Auth0 domain for the tenant (e.g.: `example.us.auth0.com` or `https://example.us.auth0.com`). If it's not specified, it will be loaded from the `AUTH0_DOMAIN` environment variable.
clientId | `string` | The Auth0 client ID. If it's not specified, it will be loaded from the `AUTH0_CLIENT_ID` environment variable.
clientSecret | `string` | The Auth0 client secret. If it's not specified, it will be loaded from the `AUTH0_CLIENT_SECRET` environment variable.
authorizationParameters | `AuthorizationParameters` | The authorization parameters to pass to the `/authorize` endpoint. See Passing authorization parameters for more details.
clientAssertionSigningKey | `string` or `CryptoKey` | Private key for use with `private_key_jwt` clients. This can also be specified via the `AUTH0_CLIENT_ASSERTION_SIGNING_KEY` environment variable.
clientAssertionSigningAlg | `string` | The algorithm used to sign the client assertion JWT. This can also be provided via the `AUTH0_CLIENT_ASSERTION_SIGNING_ALG` environment variable.
appBaseUrl | `string` | The URL of your application (e.g.: `http://localhost:3000`). If it's not specified, it will be loaded from the `APP_BASE_URL` environment variable.
secret | `string` | A 32-byte, hex-encoded secret used for encrypting cookies. If it's not specified, it will be loaded from the `AUTH0_SECRET` environment variable.
signInReturnToPath | `string` | The path to redirect the user to after successfully authenticating. Defaults to `/`.
session | `SessionConfiguration` | Configure the session timeouts and whether to use rolling sessions or not. See Session configuration for additional details.
beforeSessionSaved | `BeforeSessionSavedHook` | A method to manipulate the session before persisting it. See beforeSessionSaved for additional details.
onCallback | `OnCallbackHook` | A method to handle errors or manage redirects after attempting to authenticate. See onCallback for additional details.
sessionStore | `SessionStore` | A custom session store implementation used to persist sessions to a data store. See Database sessions for additional details.
pushedAuthorizationRequests | `boolean` | Configure the SDK to use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.
routes | `Routes` | Configure the paths for the authentication routes. See Custom routes for additional details.
allowInsecureRequests | `boolean` | Allow insecure requests to be made to the authorization server. This can be useful when testing with a mock OIDC provider that does not support TLS, locally. This option can only be used when `NODE_ENV` is not set to `production`.
httpTimeout | `number` | Integer value for the HTTP timeout in milliseconds for authentication requests. Defaults to `5000` milliseconds
enableTelemetry | `boolean` | Boolean value to opt-out of sending the library name and version to your authorization server via the `Auth0-Client` header. Defaults to `true`.

## Routes

The SDK mounts 6 routes:

1. `/auth/login`: the login route that the user will be redirected to to initiate an authentication transaction
2. `/auth/logout`: the logout route that must be added to your Auth0 application's Allowed Logout URLs
3. `/auth/callback`: the callback route that must be added to your Auth0 application's Allowed Callback URLs
4. `/auth/profile`: the route to check the user's session and return their attributes
5. `/auth/access-token`: the route to check the user's session and return an access token (which will be automatically refreshed if a refresh token is available)
6. `/auth/backchannel-logout`: the route that will receive a `logout_token` when a configured Back-Channel Logout initiator occurs

## Feedback

### Contributing

We appreciate feedback and contribution to this repo! Before you get started, please read the following:

- Auth0's general contribution guidelines
- Auth0's code of conduct guidelines
- This repo's contribution guide

### Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

## Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

## What is Auth0?

Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?

This project is licensed under the MIT license. See the LICENSE file for more info.