Skip to content

Remove from group

DELETE/directory/user-groups/{groupId}/users

Common API · Directory Management

Remove multiple users from a group.

Required permissiontenant-directory.membership:remove

Parameters

Name In Type Required Description
X-Tenant-ID header string (uuid) Yes Tenant ID.
groupId path string (uuid) Yes Group ID.
ids query array of string (uuid) No List of user IDs.
Must contain at most 50 items. Items must be unique.

Request samples

curl -X DELETE "https://api-<data-region>.central.sophos.com/common/v1/directory/user-groups/<groupId>/users" -H "Authorization: Bearer <access-token>" -H "X-Tenant-ID: <tenant-id>"


import requests

response = requests.delete(
    "https://api-<data-region>.central.sophos.com/common/v1/directory/user-groups/<groupId>/users",
    headers={
        "Authorization": "Bearer <access-token>",
        "X-Tenant-ID": "<tenant-id>",
    },
)
print(response.json())


$headers = @{
    "Authorization" = "Bearer <access-token>"
    "X-Tenant-ID" = "<tenant-id>"
}
Invoke-RestMethod -Method DELETE -Uri "https://api-<data-region>.central.sophos.com/common/v1/directory/user-groups/<groupId>/users" -Headers $headers


package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, err := http.NewRequest("DELETE", "https://api-<data-region>.central.sophos.com/common/v1/directory/user-groups/<groupId>/users", nil)
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer <access-token>")
    req.Header.Set("X-Tenant-ID", "<tenant-id>")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}


const response = await fetch("https://api-<data-region>.central.sophos.com/common/v1/directory/user-groups/<groupId>/users", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses

200 — Users removed from group.

Response fields

removedUsersarray of object
Reference to the user.
Show child attributesHide child attributes
idstring (uuid)required
User ID.
namestring
User's full name.
errorsobject
Error removing multiple users from a group.
Show child attributesHide child attributes
usersNotFoundarray of string (uuid)

Errors

Status Meaning
404 Can't find group.
500 Internal server error.

All error responses share the same shape — see the error response object.

Response examples

200

{
  "removedUsers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "errors": {
    "usersNotFound": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}