Roles

Deletes a role. The deletion CASCADES and is not reversible: the role is removed from all users that have it, all permissions granted to the role are deleted, and its layout (tool-group) assignments are detached. The response reports how many users were affected. Deletion is rejected when the role has child roles or is referenced by a workflow action's Assign To (409), and for system or locked roles (403).

delete/api/v1/roles/{roleid}

Request

Path parameters

roleidstring required

Id of the role to delete

Response

Role deleted successfully; usersAffected reports the cascade blast radius

i18nMessagesMapobject
permissionsstring[]

Example response

{
  "entity": {
    "deleted": true,
    "roleId": "48190c8c-42c4-46af-8d1a-0cd5db894797",
    "usersAffected": 3
  }
}

Changes