Group - Removes users from a group

Executes a bulk operation to remove multiple users from a specified group.

DELETE/groups/{groupId}/users

Authorization

Bearer

Path parameters

groupId*string (uuid)

Enter the ID of the group from which users will be removed.

Query parameters

Body

application/jsontext/jsonapplication/*+json

itemsstring (uuid)

Response

200500

Success: Deletion acknowledgment received.

Body

text/plainapplication/jsontext/json

messagenullable string

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the Message property.

statusCodeinteger (int32)

A public property of type integer that has both a getter and a setter method, which allows for getting and setting the value of the StatusCode property.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/groups/{groupId}/users', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "123e4567-e89b-12d3-a456-426614174000"
    ]),
});
const data = await response.json();

Response

200500

{
  "message": "Success Message",
  "statusCode": 200
}