plta-permissions-api-cbz

Create a role

Create a role scoped to an action and a resource. The caller needs manageRoles over the requested scope. A role’s access and admin grants are always contained within this scope.

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

Body

application/json

Role

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

Response

application/json

Created

Role

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

post/roles

Body

{ "roleName": "clintrials:study-reader", "scopeAction": "read", "scopeResource": "clintrials" }
 
application/json