Skip to content

Remove from groups

DELETE/directory/users/{userId}/groups

Common API · Directory Management

Remove a user from multiple groups.

Required permissiontenant-directory.membership:remove

Parameters

Name In Type Required Description
X-Tenant-ID header string (uuid) Yes Tenant ID.
userId path string (uuid) Yes User ID.
ids query array of string (uuid) No List of group 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/users/<userId>/groups" -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/users/<userId>/groups",
    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/users/<userId>/groups" -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/users/<userId>/groups", 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/users/<userId>/groups", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <access-token>",
    "X-Tenant-ID": "<tenant-id>",
  },
});
const data = await response.json();
console.log(data);

Responses

200 — User removed from the specified groups.

Response fields

removedFromGroupsarray of object
Group reference.
Show child attributesHide child attributes
idstring (uuid)required
Group ID.
namestring
Group name.
displayNamestring
Display name.
errorsobject
Error removing a user from multiple groups.
Show child attributesHide child attributes
groupsNotFoundarray of string (uuid)

Errors

Status Meaning
404 Can't find user.
409 You can't use this API to update users synced from Active Directory.
500 Internal server error.

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

Response examples

200

{
  "removedFromGroups": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "displayName": "string"
    }
  ],
  "errors": {
    "groupsNotFound": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}