Update the members of a role

patch/roles/{roleId}/members

Internal-Use Only

Updates the members of the role. Authorization: Requires the Manage Roles privilege and read access to the role context.

Request Samples

application/vnd.sas.clinical.members.update
1

Response Samples

200
application/vnd.sas.clinical.role
1{
2  "version": 1,
3  "createdBy": "sastest1",
4  "creationTimeStamp": "2023-09-26T15:46:09.962000Z",
5  "modifiedBy": "sastest1",
6  "modifiedTimeStamp": "2023-09-26T15:46:09.962000Z",
7  "id": "c39cf904-5dc5-4dab-b17e-f7960182feb0",
8  "typeId": "roleassignment",
9  "createdByDisplayName": "SAS Test User 1 (sastest1)",
10  "modifiedByDisplayName": "SAS Test User 1 (sastest1)",
11  "name": "taAdminRole",
12  "displayName": "taAdminRole",
13  "description": "Role for the therapeutic area administrator.",
14  "assignedContextId": "4437483c-dc7f-4512-986e-cde49d97d507",
15  "assignedContextTypeId": "therapeuticarea",
16  "definedContextId": "4437483c-dc7f-4512-986e-cde49d97d507",
17  "definedContextTypeId": "therapeuticarea",
18  "inherited": false
19}

Path Parameters

Name	Type	Required	Description
roleId	string	true	The unique identifier for the role. Examples: "d6eefec9-dcc2-4574-8af8-69897038d9c5"

Query Parameters

Name	Type	Required	Description
action	string	true	The membership update action to perform on the role. Allowed values: UPDATE_MEMBERSREMOVE_MEMBERS_BY_FILTER

Header Parameters

Name	Type	Required	Description
If-Match	string	true	The ETag that was returned from a GET, POST or PUT of a resource. Examples: "\"lgdxya1m\""

Request Body

The specification for member additions and removals.

The specification for updating members.

Name	Type	Required	Description
version	number	false	The version of the representation. This is version 1. Example: 1
addMembers	$ref(#/components/schemas/permissionsEntryPropagation/properties/principal)[]	false	The principal identifiers to be added.
removeMembers	$ref(#/components/schemas/permissionsEntryPropagation/properties/principal)[]	false	The principal identifiers to be removed.

Responses

Status	Meaning	Description
200	OK	OK - the role was updated	Schema
400	Bad Request	Bad Request
404	Not Found	The role could not be found.
412	Precondition Failed	The ETag provided does not match the current resource.	Schema
428	Precondition Required	The request headers did not include a `If-Match` precondition.	Schema