Search
K
plta-permissions-api-cbz

Retrieve a role

Retrieve a role by its name, including its access grants, admin grants, and members.

get
https://dev.api.sanofi.com/permissions/roles/{roleName}

Path Parameters

roleNamestringrequired

The name of the role

Response

application/json

Success

RoleDetails

A role, along with its access grants, admin grants, and members.

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

accessGrantsarray[object]read-only

An access right (an action/resource pair) attached to a role. Every member of the role inherits it. The action and resource must be within the role’s declared scope.

Show Child Parameters
adminGrantsarray[object]read-only

An admin right (an operation, with optional action/resource restrictions) attached to a role. Every member of the role inherits it. The restrictions must be within the role’s declared scope. The caller must already hold an admin right covering the exact operation and restrictions being granted.

Show Child Parameters
membersarray[object]read-only

A user attached to a role, inheriting all of its access and admin grants.

Show Child Parameters
get/roles/{roleName}
 
application/json