Skip to main content

CreatePermissionDto

namestringrequired

Permission name (unique identifier)

Example: users:create
resourcestringrequired

Resource this permission applies to

Example: users
actionstringrequired

Action this permission allows

Example: create
descriptionstringrequired

Permission description

Example: Create new users
categorystringrequired

Category for grouping

Example: user-management
isSystemPermissionboolean

Whether this is a system permission

Default value: false
isActiveboolean

Whether permission is active

Default value: true
riskLevelnumber

Risk level (1-5)

Default value: 1
Example: 1
conditions object

Permission conditions

property name*any

Permission conditions

settings object

Permission settings

property name*any

Permission settings

displayOrdernumber

Display order

Default value: 0
iconstring

Icon name

colorstring

Color code

metadata object

Permission metadata

property name*any

Permission metadata

CreatePermissionDto
{
"name": "users:create",
"resource": "users",
"action": "create",
"description": "Create new users",
"category": "user-management",
"isSystemPermission": false,
"isActive": true,
"riskLevel": 1,
"conditions": {},
"settings": {},
"displayOrder": 0,
"icon": "string",
"color": "string",
"metadata": {}
}