Skip to main content

CreateRoleDto

namestringrequired

Role name (unique identifier)

Example: admin
descriptionstringrequired

Role description

Example: Administrator role with full access
levelnumber

Role level (higher = more authority)

Default value: 1
Example: 1
isSystemRoleboolean

Whether this is a system role

Default value: false
isActiveboolean

Whether role is active

Default value: true
colorstring

Color code for UI (hex format)

Example: #140EAC
iconstring

Icon name for UI

Example: shield
displayOrdernumber

Display order

Default value: 0
settings object

Role settings

property name*any

Role settings

metadata object

Role metadata

property name*any

Role metadata

permissionIdsstring[]

Permission IDs to assign to this role

CreateRoleDto
{
"name": "admin",
"description": "Administrator role with full access",
"level": 1,
"isSystemRole": false,
"isActive": true,
"color": "#140EAC",
"icon": "shield",
"displayOrder": 0,
"settings": {},
"metadata": {},
"permissionIds": [
"string"
]
}