Update Group Members
patch/groups/{groupId}/members
Adds or removes members from a group.
1{2 "value": {3 "version": 1,4 "createdBy": "sastest1",5 "creationTimeStamp": "2023-09-28T04:16:51.079000Z",6 "modifiedBy": "sastest1",7 "modifiedTimeStamp": "2023-09-28T04:16:51.079000Z",8 "id": "89f8713d-682e-449a-903c-896bc35ef3aa",9 "typeId": "group",10 "createdByDisplayName": "SAS Test User 1 (sastest1)",11 "modifiedByDisplayName": "SAS Test User 1 (sastest1)",12 "name": "Test Group 1",13 "description": "Remote Test Group",14 "contextId": "35f9a2ed-88ab-4f11-95cd-70a262df31e5",15 "contextTypeId": "organization"16 }17}
| Name | Type | Required | Description |
|---|---|---|---|
groupId | string | true | The identifier of the group to be modified. |
| Name | Type | Required | Description |
|---|---|---|---|
action | string | true | The membership update action to perform on the context. 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 group member additions or 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 | Headers | Schema |
| 400 | Bad Request | Bad Request | ||
| 404 | Not Found | The group could not be found. | ||
| 412 | Precondition Failed | Precondition failed | ||
| 428 | Precondition Required | Precondition required |