plta-permissions-api-cbz

Retrieve a list of admin rights

Allows the retrieval of all available admin rights across all users.

get
https://dev.api.sanofi.com/permissions/adminRights

Response

application/json

Success

the combination of a user and an administrative operation (such as creating a new action or resource).

actionRestrictionstring

Name of the action that will restrict the action usable in an operation to a specific hierarchy. If defined, an administrator performing an operation related to an action will need to have this action name either as a direct parent or as an ancestor of the parent of the action he is using. If not defined, the administrator will be able to use any action.

Example:write_narrative, read_compound

adminRightIdstring(uuid)read-only

the unique identifier of the admin right, mostly for deletion purpose.

operationNamestringrequired

Name of the operation.

Example:manageAdminRights, manageActions, manageResources

operationRestrictionsarray[string]

Name of an allowed operation. Values are operation names, typically using the same naming convention as operationName (for example: manageAdminRights, manageActions, manageResources). If this array is defined, a user having a manageAdminRights will only be able to create a new admin right with the operations listed here. If not defined, the user will be able to create a new admin right with any operation. The OpenAPI schema does not formally restrict these values; any applicable validation is enforced by the server.

resourceRestrictionstring

Name of the resource that will restrict the resource usable in an operation to a specific hierarchy. If defined, an administrator performing an operation related to a resource will need to have this resource name either as a direct parent or as an ancestor of the parent of the resource he is using. If not defined, the administrator will be able to use any resource.

Example:compound_1245, study_1245

scopestring

Scope of the admin right. If defined, the name of the action or resource will need to start by this scope as prefix (exemple-> “clinshow:write_narrative”, “dpt:read_compound”, “platform:manage_admin_rights”). If not defined, the admin right will be usable in any scope.

Example:clinshow, dpt, platform

userIdstringrequired

The id of the user, as stored in IDP. For Sanofi internal user, it would be the oid (Unique identifier of the user in Azure AD)

get/adminRights
 
application/json