UpdateRoleRequest

Request to update a custom role. This is a full replacement — the role's name, description and
entire permission set are overwritten with the values supplied.

Properties

Name	Type	Description
name*	string	The display name of the role. Must be unique within the practice and cannot use a built-in role name (Admin, Standard User, Viewer).
The display name of the role. Must be unique within the practice and cannot use a built-in role name (Admin, Standard User, Viewer).
description	string	Optional description of what this role is for
Optional description of what this role is for
permissions	object	The capabilities to grant per entity. Capabilities are independent flags — include every capability the role should have; "Admin" grants everything on that entity. Grants are capped at the capabilities the requesting user themselves holds on each entity: anything beyond that is silently reduced, not rejected.
The capabilities to grant per entity. Capabilities are independent flags — include every capability the role should have; "Admin" grants everything on that entity. Grants are capped at the capabilities the requesting user themselves holds on each entity: anything beyond that is silently reduced, not rejected.

JSON Example

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

Used By Operations

PUT Update Role
/tenants/{tenant}/roles/{code}