PUT api/v2/groups/{groupName}/members

Replaces a group's entire membership list (idempotent).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupName

The name of the group whose membership is being replaced.

string

Required

Body Parameters

The identifier type and full list of members the group should contain.

GroupMembersRequest
NameDescriptionTypeAdditional information
identifierType

How each entry in identifies a user. One of "id", "username", or "email". Defaults to "id".

string

None.

members

The user identifiers (of the given ) to add, replace, or remove.

Collection of string

None.

Request Formats

application/json, text/json, application/scim+json

Sample:
{
  "identifierType": "sample string 1",
  "members": [
    "sample string 1",
    "sample string 2"
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/scim+json

Sample:

Sample not available.