Skip to content

Interface: RbacMiddlewareWithRbac<Req> ​

Defined in: packages/next/src/middleware.ts:37

Loads roles & permissions through an Rbac instance (DB adapters need the Node.js middleware runtime).

Extends ​

  • BaseOptions<Req>

Type Parameters ​

Type Parameter
Req extends MiddlewareRequest

Properties ​

PropertyTypeDescriptionInherited fromDefined in
getSnapshot?undefined--packages/next/src/middleware.ts:42
getSubject(req) => MaybePromise<Subject | null | undefined>--packages/next/src/middleware.ts:39
guard?string--packages/next/src/middleware.ts:40
loginUrl?string | ((req) => string | URL)Redirect guests here (relative to the request URL). Without it, guests get a 401 JSON response.BaseOptions.loginUrlpackages/next/src/middleware.ts:29
onUnauthenticated?(req, rule) => MaybePromise<Response>Custom response for guests.BaseOptions.onUnauthenticatedpackages/next/src/middleware.ts:31
onUnauthorized?(req, rule) => MaybePromise<Response>Custom response for users missing a role/permission. Default: 403 JSON response.BaseOptions.onUnauthorizedpackages/next/src/middleware.ts:33
rbacRbac--packages/next/src/middleware.ts:38
rulesreadonly RbacMiddlewareRule[]Every matching rule must pass. Requests matching no rule pass through.RbacMiddlewareWithSnapshot.rulespackages/next/src/middleware.ts:27
team?| TeamId | ((req) => MaybePromise<TeamId | undefined>)--packages/next/src/middleware.ts:41

Released under the MIT License. Inspired by spatie/laravel-permission.