Add or remove members from a context

patch/memberships/{membershipId}/members

Adds or removes members from a context.

Request Samples

1

Response Samples

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

Path Parameters

NameTypeRequiredDescription
membershipId
string
true

The unique identifier for the context for which to update the members.

Query Parameters

NameTypeRequiredDescription
action
string
true

The membership update action to perform on the context.

Allowed values:
UPDATE_MEMBERSREMOVE_MEMBERS_BY_FILTER

Header Parameters

NameTypeRequiredDescription
If-Match
string
true

The ETag that was returned from a GET, POST or PUT of a resource.

Request Body

The specification for context member additions or removals.

Specification for updating members.

NameTypeRequiredDescription
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.

Responses

StatusMeaningDescription
200OK

The request succeeded and the specified context members were updated.

HeadersSchema
400Bad Request

Bad Request

412Precondition Failed

Precondition failed

428Precondition Required

Precondition required