Update the members of a role
patch/roles/{roleId}/members
Updates the members of the role.
Authorization: Requires the Manage Roles privilege and read access to the role context.
1{2 "value": {3 "version": 1,4 "createdBy": "sastest1",5 "creationTimeStamp": "2023-09-26T15:46:09.962000Z",6 "modifiedBy": "sastest1",7 "modifiedTimeStamp": "2023-09-26T15:46:09.962000Z",8 "id": "c39cf904-5dc5-4dab-b17e-f7960182feb0",9 "typeId": "roleassignment",10 "createdByDisplayName": "SAS Test User 1 (sastest1)",11 "modifiedByDisplayName": "SAS Test User 1 (sastest1)",12 "name": "taAdminRole",13 "displayName": "taAdminRole",14 "description": "Role for the therapeutic area administrator.",15 "assignedContextId": "4437483c-dc7f-4512-986e-cde49d97d507",16 "assignedContextTypeId": "therapeuticarea",17 "definedContextId": "4437483c-dc7f-4512-986e-cde49d97d507",18 "definedContextTypeId": "therapeuticarea",19 "inherited": false20 }21}
| Name | Type | Required | Description |
|---|---|---|---|
action | string | true | The membership update action to perform on the role. Allowed values: UPDATE_MEMBERSREMOVE_MEMBERS_BY_FILTER |
| Name | Type | Required | Description |
|---|---|---|---|
If-Match | string | true | The ETag that was returned from a GET, POST or PUT of a resource. |
The specification for member additions and removals.
Specification for updating members.
| Name | Type | Required | Description |
|---|---|---|---|
version | number | false | The version of the representation. This is version 1. |
addMembers | array [Principal Identity] | false | The principal identifiers to be added. |
removeMembers | array [Principal Identity] | false | The principal identifiers to be removed. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | OK - the role was updated | Headers | Schema |
| 400 | Bad Request | Bad Request | ||
| 404 | Not Found | The role could not be found. | ||
| 412 | Precondition Failed | Precondition failed | ||
| 428 | Precondition Required | Precondition required |