Create a New Role for the Data Protection REST API

Since the endpoints for the Data Protection REST API require special permissions, you should create a new role for granting them.

Before you begin

The task requires the following:
  • Access to an instance of the eperi sEcure Platform which is up and running.
  • Valid credentials of an existing administrator account.
  • The administrator account used has the required roles and permissions for the desired operations.

About this task

In order to use this API, the user needs the following permissons:
  • Use Data Protection API
  • Use Data Unprotection API
Note: The best practice for assigning these permissions is to create a dedicated role instead of assigning the necessary permissions to an existing role.

Procedure

  1. From User Management navigate to Roles.
  2. Click + New to create a new role.
  3. Provide an appropriate name for this role, e.g., Data Protection Manager
  4. Provide an appropriate description for this role, e.g., For granting the required REST API permissions (Protect/Unprotect)
  5. Click Submit then OK once it has been created.
  6. Click the Assign Permissions icon for this new role.


  7. In the Assign Permissions for Data Protection Manager dialog, toggle both the Use Data Protection API and the Use Data Unprotection API permissions as shown below.


  8. Assign the new Data Protection Manager role to a user by navigating to User Management > Administrators and selecting the Assign Roles icon for the administrator who should be granted these permissions.


  9. Toggle the Data Protection Manager role and click Assign.


Results

You have successfully created a new role for accessing the Data Protection REST API and assigned this role to an administrator.

What to do next

You can now protect your data with the Protect API.