DELETE api/groups/{id}/members?field={field}

Removes one or more users from a specified group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique identifier of the group from which users will be removed.

integer

Required

field

(Optional) The field used to identify users. Accepts "id", "username", or "email". Defaults to "id".

string

Default value is id

Body Parameters

A list of user identifiers (IDs, usernames, or emails) to be removed from the group.

Collection of string

Request Formats

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

Sample:
[
  "sample string 1",
  "sample string 2"
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

On success: HTTP 200 OK indicating users were removed successfully. On failure: HTTP 400 Bad Request with a specific error message.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.