plta-permissions-api-cbz

Retrieve a list of roles

Allows the retrieval of all roles. Requires an unrestricted manageRoles right; the list is not scoped to the caller. Access grants, admin grants, and members are not returned here.

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

Response

application/json

Success

A named bundle of access and admin grants, scoped to an action and a resource. All of a role’s grants are always contained within this scope.

descriptionstring

A human-readable description of the role’s purpose.

roleNamestringrequired

The business identifier of the role.

Example:clintrials:study-reader

scopeActionstringrequired

The action (with its hierarchy) that bounds this role’s access and admin grants. Immutable once the role is created.

Example:read

scopeResourcestringrequired

The resource (with its hierarchy) that bounds this role’s access and admin grants. Immutable once the role is created.

Example:clintrials

get/roles
 
application/json