Skip to content

Interface: RbacMiddlewareWithSnapshot<Req> ​

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

Reads roles & permissions from somewhere cheap, e.g. the session/JWT. Works in the Edge runtime.

Extends ​

  • BaseOptions<Req>

Type Parameters ​

Type Parameter
Req extends MiddlewareRequest

Properties ​

PropertyTypeDescriptionInherited fromDefined in
getSnapshot(req) => MaybePromise<RbacSnapshot | null | undefined>Return null for guests.-packages/next/src/middleware.ts:48
getSubject?undefined--packages/next/src/middleware.ts:54
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
rbac?undefined--packages/next/src/middleware.ts:53
rulesreadonly RbacMiddlewareRule[]Every matching rule must pass. Requests matching no rule pass through.BaseOptions.rulespackages/next/src/middleware.ts:27
superAdminRoles?readonly string[]Roles that pass every permission check.-packages/next/src/middleware.ts:52
wildcard?booleanMust match the server's wildcard setting. Default: false.-packages/next/src/middleware.ts:50

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