Update Group Members
patch/groups/{groupId}/members
Adds or removes members from a group.
1{2 "version": 1,3 "createdBy": "sastest1",4 "creationTimeStamp": "2023-09-28T04:16:51.079000Z",5 "modifiedBy": "sastest1",6 "modifiedTimeStamp": "2023-09-28T04:16:51.079000Z",7 "id": "89f8713d-682e-449a-903c-896bc35ef3aa",8 "typeId": "group",9 "createdByDisplayName": "SAS Test User 1 (sastest1)",10 "modifiedByDisplayName": "SAS Test User 1 (sastest1)",11 "name": "Test Group 1",12 "description": "Remote Test Group",13 "contextId": "35f9a2ed-88ab-4f11-95cd-70a262df31e5",14 "contextTypeId": "organization"15}
| 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.
The specification for updating members.
| Name | Type | Required | Description |
|---|---|---|---|
version | number | false | The version of the representation. This is version 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. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | OK | Schema | |
| 400 | Bad Request | Bad Request | ||
| 404 | Not Found | The group 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 | Schema |