Privileges

A privilege is the most granular element that defines a single, specific action a user is authorised to perform on a resource. Each API endpoint or action requires one or more particular privileges for access.

Finding required privileges

To determine which privilege is required for a specific endpoint, refer to the endpoint's description in the API Explorer. The access requirement is displayed as:

Access rules: hasAnyAuthorityOrRole(PRIVILEGE_NAME)

Use the Get all privileges endpoint to retrieve a complete list of available privileges in the Tuum system.

Privilege types

There are two types of privileges:

• View privileges — Allow a principal to access data without permission to modify it.

• Action privileges — Allow a principal to add, update, or delete data.

Assigning privileges to the user

To assign privileges to users, follow this two-step approach:

1. Define roles consisting of the privileges needed for particular types of users.

2. Assign the appropriate role to each user.