RbacConfig
Defined in: src/policies/auth/rbac.ts:13
Configuration for the rbac policy.
Extends
Section titled “Extends”Properties
Section titled “Properties”denyMessage?
Section titled “denyMessage?”
optionaldenyMessage:string
Defined in: src/policies/auth/rbac.ts:27
Custom deny message. Default: “Access denied: insufficient permissions”.
permissionDelimiter?
Section titled “permissionDelimiter?”
optionalpermissionDelimiter:string
Defined in: src/policies/auth/rbac.ts:23
Delimiter for permission string. Default: ”,“.
permissionHeader?
Section titled “permissionHeader?”
optionalpermissionHeader:string
Defined in: src/policies/auth/rbac.ts:21
Header containing permissions. Default: “x-user-permissions”.
permissions?
Section titled “permissions?”
optionalpermissions:string[]
Defined in: src/policies/auth/rbac.ts:19
Required permissions — pass if user has ALL of these.
roleDelimiter?
Section titled “roleDelimiter?”
optionalroleDelimiter:string
Defined in: src/policies/auth/rbac.ts:25
Delimiter for role string. Default: ”,“.
roleHeader?
Section titled “roleHeader?”
optionalroleHeader:string
Defined in: src/policies/auth/rbac.ts:15
Header name containing the user’s role(s). Default: “x-user-role”.
roles?
Section titled “roles?”
optionalroles:string[]
Defined in: src/policies/auth/rbac.ts:17
Allowed roles — pass if user has ANY of these.
skip()?
Section titled “skip()?”
optionalskip: (c) =>boolean|Promise<boolean>
Defined in: src/policies/types.ts:33
Skip this policy when condition returns true
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”boolean | Promise<boolean>