Edit Global Roles using Native API

[DS-INRAE]

Overview of the Feature Request
As an installation administrator (superuser),
I can update the global roles set for my installation using an API call
In order to avoid creating and deleting roles to adjust the permissions for my installation's role

What kind of user is the feature intended for?
Superuser

What inspired the request?
Our Use Case at Recherche Data Gouv : we want to have the collections' "Curator" role without the AddDataverse permission.
While if can be done either in the database or by creating & removing roles, it would be much cleaner and configurable for all installations to be able to tailor the roles via API.

We'd also like to edit the contributor role to allow them to manage file restrictions and private URLs but we'll need this issue resolved first for the second part:

• Add a ManagePrivateURL permission #10574

Any brand new behavior do you want to add to Dataverse?

Add an API admin command to update a global role in the Dataverse installation. The data POSTed are assumed to be a role JSON.

POST http://$SERVER/api/admin/roles/$id

Example:

export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export SERVER_URL=https://demo.dataverse.org
export ID=24

curl -H "X-Dataverse-key:$API_TOKEN" -X POST "$SERVER_URL/api/admin/roles/$id" --upload-file roles.json

Document the new API command in the Native API guide between Create Global Role and Delete a Global Role

Any open or closed issues related to this feature request?

Issues about editing permissions for a role:

• Creating private URL not possible for the role "Contributor" #9938

Ability to improve description of a role for one's installation, especially if it has been modified:

• Permissions - Improve Descriptions of Roles #4389

Similar issue, but for editing collection-level roles (needed for SPA):

• Edit a role in a collection using Native API #10716

Bugs that may affect/be affected by the feature:

• Custom roles cannot be edited, throws error: "The role was not able to be saved. Role with this alias already exists" #8808
• Permissions: Problem creating and assigning a custom role #2693
• Permissions: Need to check for unique role id, can create roles with same name and alias, different perms. #1135

Will you be able to contribute a Pull Request for this issue?
We'll need to investigate the effort needed, but as it will probably be a lot of work we are not likely to do it at least in 2024.

[DS-INRAE]

I finally created the parallel issue for roles in collections here:

• Edit a role in a collection using Native API #10716