Roles
A role is a named collection of privileges outlining a specific set of actions a user can perform. Using roles simplifies permission management by allowing you to assign a single role to a user rather than configuring multiple individual privileges.
A role can include an unlimited number of privileges.
Predefined roles
Tuum provides two predefined roles:
ADMIN — Can view and manage all company-related data, including full employee management capabilities.
SYSTEM — Designed for principals accessing the system via APIs, such as third-party applications or internal microservices.
You may use the predefined roles as provided, but you are not allowed to modify them.
Create roles
Beyond these predefined roles, you can create custom roles tailored to your organisation's specific needs.
Use the Create role endpoint to create a new custom role. In the request body, specify the privileges that should be included in the role.
Manage roles
The following API endpoints are available for managing roles in Tuum.
Use the Get all roles endpoint to view all defined roles in the Tuum system.
Use the Get privileges for role endpoint to view which privileges are assigned to a specific role.
Use the Add privileges for role endpoint to add privileges to the specific role.
Use the Remove privilege endpoint to remove a specific privilege assigned to a role.
Use the Remove privileges endpoint to remove multiple privileges from a role.
Delete role
Use the Delete role endpoint to remove a specific role.
Last updated
Was this helpful?