Add or remove members from a context

patch/memberships/{membershipId}/members

Internal-Use Only

Adds or removes members from a context.

Request Samples

application/json
1

Response Samples

200
application/json
1{
2  "version": 1,
3  "id": "8646b35d-5ee5-43cb-860d-12f66c0e7e56",
4  "typeId": "membership",
5  "contextTypeId": "project",
6  "createdBy": "sastest1",
7  "creationTimeStamp": "2023-09-28T01:15:49.143000Z",
8  "createdByDisplayName": "SAS Test User 1 (sastest1)",
9  "modifiedBy": "sastest1",
10  "modifiedTimeStamp": "2023-09-28T01:15:49.143000Z",
11  "modifiedByDisplayName": "SAS Test User 1 (sastest1)"
12}

Path Parameters

Name	Type	Required	Description
membershipId	string	true	The unique identifier for the context for which to update the members.

Query Parameters

Name	Type	Required	Description
action	string	true	The membership update action to perform on the context. 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 context 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. 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	The request succeeded and the specified context members were updated.	Schema
400	Bad Request	Bad Request
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