Options
All
  • Public
  • Public/Protected
  • All
Menu

Module helpers/with-api-auth-required

Index

Server Type aliases

Server Type aliases

WithApiAuthRequired

WithApiAuthRequired: (apiRoute: NextApiHandler) => NextApiHandler

Wrap an API Route to check that the user has a valid session. If they're not logged in the handler will return a 401 Unauthorized.

// pages/api/protected-route.js
import { withApiAuthRequired, getSession } from '@auth0/nextjs-auth0';

export default withApiAuthRequired(function ProtectedRoute(req, res) {
  const session = getSession(req, res);
  ...
});

If you visit /api/protected-route without a valid session cookie, you will get a 401 response.

Type declaration

    • (apiRoute: NextApiHandler): NextApiHandler
    • Parameters

      • apiRoute: NextApiHandler

      Returns NextApiHandler