Roles
Delete a role
Changed onDeletes 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
- Base URLhttps://docs.anzworldline-solutions.com.au
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
roleidstring required
Id of the role to delete
Response
Role deleted successfully; usersAffected reports the cascade blast radius
Example response
{
"entity": {
"deleted": true,
"roleId": "48190c8c-42c4-46af-8d1a-0cd5db894797",
"usersAffected": 3
}
}Changes
- info
endpoint added
- info