RoleDto

A custom (tenant-defined) role and the capabilities it grants per entity.

Properties

Name	Type	Description
code	string	The unique code identifying this role
The unique code identifying this role
name	string	The display name of the role
The display name of the role
description	string	Optional description of what this role is for
Optional description of what this role is for
assignedUserCount	integer	The number of users currently assigned to this role
The number of users currently assigned to this role
permissions	object	The capabilities granted per entity. Each entry lists the granted capabilities individually — there is no implicit hierarchy; an entry containing "Admin" grants every capability on that entity. Entities granting nothing are omitted.
The capabilities granted per entity. Each entry lists the granted capabilities individually — there is no implicit hierarchy; an entry containing "Admin" grants every capability on that entity. Entities granting nothing are omitted.
createdDate	string	When the role was created
When the role was created
updatedDate	string	When the role was last updated
When the role was last updated

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "assignedUserCount": 0,
  "permissions": {
    "Tasks": [
      "..."
    ],
    "Users": [
      "..."
    ],
    "Clients": [
      "..."
    ],
    "Contacts": [
      "..."
    ],
    "ClientContacts": [
      "..."
    ]
  }
}

Used By Operations

Contained in Schemas

RoleDtoPagedResult