API Docs / Schemas / SystemRolePermissionsDto

SystemRolePermissionsDto

A built-in system role and the capabilities it grants per entity, as they apply within
this tenant. Mirrors the shape of SodiumHQ.DTOs.Role.RoleDto.Permissions so the two can be
rendered by the same permission grid.

Properties

Name Type Description
systemRoleenum

Admin StandardUser Viewer

Admin StandardUser Viewer

permissionsobject

The capabilities granted per entity, already intersected with the tenant's package —
a grant on an entity the package excludes is inert, so it is omitted rather than
promising access the user would never get. Entities granting nothing are omitted too.

The capabilities granted per entity, already intersected with the tenant's package —
a grant on an entity the package excludes is inert, so it is omitted rather than
promising access the user would never get. Entities granting nothing are omitted too.

JSON Example

{
  "systemRole": "Admin",
  "permissions": {
    "Tasks": [
      "..."
    ],
    "Users": [
      "..."
    ],
    "Clients": [
      "..."
    ],
    "Contacts": [
      "..."
    ],
    "ClientContacts": [
      "..."
    ]
  }
}