diff --git a/articles/quickstart/webapp/nextjs/01-login.md b/articles/quickstart/webapp/nextjs/01-login.md index 7bffa91d5f..74d19680bc 100644 --- a/articles/quickstart/webapp/nextjs/01-login.md +++ b/articles/quickstart/webapp/nextjs/01-login.md @@ -14,7 +14,7 @@ useCase: quickstart --- -<%= include('../_includes/_getting_started', { library: 'Next.js', callback: 'http://localhost:3000/api/auth/callback' }) %> +<%= include('../_includes/_getting_started', { library: 'Next.js', callback: 'http://localhost:3000/auth/callback' }) %> <%= include('../../../_includes/_logout_url', { returnTo: 'http://localhost:3000' }) %> @@ -23,98 +23,133 @@ useCase: quickstart Run the following command within your project directory to install the Auth0 Next.js SDK: ```sh -npm install @auth0/nextjs-auth0@3 +npm install @auth0/nextjs-auth0 ``` The SDK exposes methods and variables that help you integrate Auth0 with your Next.js application using Route Handlers on the backend and React Context with React Hooks on the frontend. ### Configure the SDK -In the root directory of your project, add the file `.env.local` with the following environment variables: +In the root directory of your project, create the file `.env.local` with the following environment variables: ```sh AUTH0_SECRET='use [openssl rand -hex 32] to generate a 32 bytes value' -AUTH0_BASE_URL='http://localhost:3000' -AUTH0_ISSUER_BASE_URL='https://${account.namespace}' +APP_BASE_URL='http://localhost:3000' +AUTH0_DOMAIN='https://${account.namespace}' AUTH0_CLIENT_ID='${account.clientId}' AUTH0_CLIENT_SECRET='${account.clientSecret}' +'If your application is API authorized add the variables AUTH0_AUDIENCE and AUTH0_SCOPE' +AUTH0_AUDIENCE='your_auth_api_identifier' +AUTH0_SCOPE='openid profile email read:shows' ``` - `AUTH0_SECRET`: A long secret value used to encrypt the session cookie. You can generate a suitable string using `openssl rand -hex 32` on the command line. -- `AUTH0_BASE_URL`: The base URL of your application. -- `AUTH0_ISSUER_BASE_URL`: The URL of your Auth0 tenant domain. If you are using a Custom Domain with Auth0, set this to the value of your Custom Domain instead of the value reflected in the "Settings" tab. -- `AUTH0_CLIENT_ID`: Your Auth0 application's Client ID. -- `AUTH0_CLIENT_SECRET`: Your Auth0 application's Client Secret. +- `APP_BASE_URL`: The base URL of your application +- `AUTH0_DOMAIN`: The URL of your Auth0 tenant domain +- `AUTH0_CLIENT_ID`: Your Auth0 application's Client ID +- `AUTH0_CLIENT_SECRET`: Your Auth0 application's Client Secret -The SDK will read these values from the Node.js process environment and automatically configure itself. +The SDK will read these values from the Node.js process environment and configure itself automatically. -### Add the dynamic API route handler +::: note +Manually add the values for `AUTH0_AUDIENCE` and `AUTH_SCOPE` to the file `lib/auth0.js`. These values are not configured automatically. +If you are using a Custom Domain with Auth0, set `AUTH0_DOMAIN` to the value of your Custom Domain instead of the value reflected in the application "Settings" tab. +::: -Create a file at `app/api/auth/[auth0]/route.js`. This is your Route Handler file with a Dynamic Route Segment. +### Create the Auth0 SDK Client -Then, import the `handleAuth` method from the SDK and call it from the `GET` export. +Create a file at `lib/auth0.js` to add an instance of the Auth0 client. This instance provides methods for handling authentication, sesssions and user data. ```javascript -// app/api/auth/[auth0]/route.js -import { handleAuth } from '@auth0/nextjs-auth0'; - -export const GET = handleAuth(); +// lib/auth0.js + +import { Auth0Client } from "@auth0/nextjs-auth0/server"; + +// Initialize the Auth0 client +export const auth0 = new Auth0Client({ + // Options are loaded from environment variables by default + // Ensure necessary environment variables are properly set + // domain: process.env.AUTH0_DOMAIN, + // clientId: process.env.AUTH0_CLIENT_ID, + // clientSecret: process.env.AUTH0_CLIENT_SECRET, + // appBaseUrl: process.env.APP_BASE_URL, + // secret: process.env.AUTH0_SECRET, + + authorizationParameters: { + // In v4, the AUTH0_SCOPE and AUTH0_AUDIENCE environment variables for API authorized applications are no longer automatically picked up by the SDK. + // Instead, we need to provide the values explicitly. + scope: process.env.AUTH0_SCOPE, + audience: process.env.AUTH0_AUDIENCE, + } +}); ``` -This creates the following routes: +### Add the Authentication Middleware -- `/api/auth/login`: The route used to perform login with Auth0. -- `/api/auth/logout`: The route used to log the user out. -- `/api/auth/callback`: The route Auth0 will redirect the user to after a successful login. -- `/api/auth/me`: The route to fetch the user profile from. +The Next.js Middleware allows you to run code before a request is completed. +Create a `middleware.ts` file. This file is used to enforce authentication on specific routes. -::: note -This QuickStart targets the Next.js App Router. If you're using the Pages Router, check out the example in the SDK's README. -::: +```javascript +import type { NextRequest } from "next/server"; +import { auth0 } from "./lib/auth0"; -### Add the `UserProvider` component +export async function middleware(request: NextRequest) { + return await auth0.middleware(request); +} -On the frontend side, the SDK uses React Context to manage the authentication state of your users. To make that state available to all your pages, you need to override the Root Layout component and wrap the `` tag with a `UserProvider` in the file `app/layout.jsx`. +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).*)", + ], +}; +``` -Create the file `app/layout.jsx` as follows: +The `middleware` function intercepts incoming requests and applies Auth0's authentication logic. The `matcher` configuration ensures that the middleware runs on all routes except for static files and metadata. -```jsx -// app/layout.jsx -import { UserProvider } from '@auth0/nextjs-auth0/client'; +#### Auto-configured routes -export default function RootLayout({ children }) { - return ( - - - {children} - - - ); -} -``` +Using the SDK's middleware auto-configures the following routes: -The authentication state exposed by `UserProvider` can be accessed in any Client Component using the `useUser()` hook. +- `/auth/login`: The route to perform login with Auth0 +- `/auth/logout`: The route to log the user out +- `/auth/callback`: The route Auth0 will redirect the user to after a successful login +- `/auth/profile`: The route to fetch the user profile +- `/auth/access-token`: The route to verify the user's session and return an access token (which automatically refreshes if a refresh token is available) +- `/auth/backchannel-logout`: The route to receive a `logout_token` when a configured Back-Channel Logout initiator occurs -:::panel Checkpoint -Now that you have added the dynamic route and `UserProvider`, run your application to verify that your application is not throwing any errors related to Auth0. +:::note +The `/auth/access-token` route is enabled by default, but is only neccessary when the access token is needed on the client-side. If this isn't something you need, you can disable this endpoint by setting `enableAccessTokenEndpoint` to `false`. ::: ## Add Login to Your Application -Users can now log in to your application by visiting the `/api/auth/login` route provided by the SDK. Add a link that points to the login route using an **anchor tag**. Clicking it redirects your users to the Auth0 Universal Login Page, where Auth0 can authenticate them. Upon successful authentication, Auth0 will redirect your users back to your application. - -:::note -Next linting rules might suggest using the `Link` component instead of an anchor tag. The `Link` component is meant to perform client-side transitions between pages. As the link points to an API route and not to a page, you should keep it as an anchor tag. -::: +Users can now log in to your application at `/auth/login` route provided by the SDK. Use an **anchor tag** to add a link to the login route to redirect your users to the Auth0 Universal Login Page, where Auth0 can authenticate them. Upon successful authentication, Auth0 redirects your users back to your application. ```html -Login +Login ``` +:::note +Next.js suggests using Link components instead of anchor tags, but since these are API routes and not pages, anchor tags are needed. +::: + :::panel Checkpoint -Add the login link to your application. When you click it, verify that your Next.js application redirects you to the Auth0 Universal Login page and that you can now log in or sign up using a username and password or a social provider. +Add the login link to your application. Select it and verify that your Next.js application redirects you to the Auth0 Universal Login page and that you can now log in or sign up using a username and password or a social provider. Once that's complete, verify that Auth0 redirects back to your application. + +If you are following along with the sample app project from the top of this page, run the command: + +```sh +npm i && npm run dev +``` +and visit http://localhost:3000 in your browser. ::: ![Auth0 Universal Login](/media/quickstarts/universal-login.png) @@ -123,14 +158,14 @@ Once that's complete, verify that Auth0 redirects back to your application. ## Add Logout to Your Application -Now that you can log in to your Next.js application, you need a way to log out. Add a link that points to the `/api/auth/logout` API route. Clicking it redirects your users to your Auth0 logout endpoint (`https://YOUR_DOMAIN/v2/logout`) and then immediately redirects them back to your application. +Now that you can log in to your Next.js application, you need a way to log out. Add a link that points to the `/auth/logout` API route. To learn more, read Log Users out of Auth0 with OIDC Endpoint. ```html -Logout +Logout ``` :::panel Checkpoint -Add the logout link to your application. When you click it, verify that your Next.js application redirects you to the address you specified as one of the "Allowed Logout URLs" in the "Settings". +Add the logout link to your application. When you select it, verify that your Next.js application redirects you to the address you specified as one of the "Allowed Logout URLs" in the application "Settings". ::: ## Show User Profile Information @@ -144,22 +179,24 @@ The profile information is available through the `user` property exposed by the ```jsx 'use client'; -import { useUser } from '@auth0/nextjs-auth0/client'; - -export default function ProfileClient() { - const { user, error, isLoading } = useUser(); - - if (isLoading) return
Loading...
; - if (error) return
{error.message}
; - +export default function Profile() { + const { user, isLoading } = useUser(); return ( - user && ( -
- {user.name} -

{user.name}

-

{user.email}

-
- ) + <> + {isLoading &&

Loading...

} + {user && ( +
+ Profile +

{user.name}

+

{user.email}

+ 
{JSON.stringify(user, null, 2)}
+
+ )} + ); } ``` @@ -175,32 +212,19 @@ The `user` property contains sensitive information and artifacts related to the The profile information is available through the `user` property exposed by the `getSession` function. Take this Server Component as an example of how to use it: ```jsx -import { getSession } from '@auth0/nextjs-auth0'; +import { auth0 } from "@/lib/auth0"; export default async function ProfileServer() { - const { user } = await getSession(); - - return ( - user && ( -
- {user.name} -

{user.name}

-

{user.email}

-
- ) - ); + const { user } = await auth0.getSession(); + return ( user && (
{user.name}/

{user.name}

{user.email}

) ); } + ``` :::panel Checkpoint Verify that you can display the `user.name` or any other `user` property within a component correctly after you have logged in. -::: +::: ## What's next? -We put together a few examples of how to use nextjs-auth0 in more advanced use cases: - -- Protecting a Server Side Rendered (SSR) Page -- Protecting a Client Side Rendered (CSR) Page -- Protect an API Route -- Access an External API from an API Route +We put together a few examples on how to use nextjs-auth0 for more advanced use cases. diff --git a/articles/quickstart/webapp/nextjs/download.md b/articles/quickstart/webapp/nextjs/download.md index e1adb730a4..b80e4d475b 100644 --- a/articles/quickstart/webapp/nextjs/download.md +++ b/articles/quickstart/webapp/nextjs/download.md @@ -4,7 +4,7 @@ To run the sample follow these steps: 1) Set the **Allowed Callback URLs** in the Application Settings to ```text -http://localhost:3000/api/auth/callback +http://localhost:3000/auth/callback ``` 2) Set **Allowed Logout URLs** in the Application Settings to diff --git a/articles/quickstart/webapp/nextjs/index.yml b/articles/quickstart/webapp/nextjs/index.yml index ad6a5b3b9a..2fc7d9d1fc 100644 --- a/articles/quickstart/webapp/nextjs/index.yml +++ b/articles/quickstart/webapp/nextjs/index.yml @@ -23,7 +23,7 @@ seo_alias: nextjs show_releases: true show_steps: true requirements: - - Next.js 13.4+ + - Next.js 15.2.4+ default_article: 01-login articles: - 01-login