Summary

For a variety of reasons, you may want to remove users from a group. You can do this with the removeUsersFromGroup() GraphQL mutation. Doing so doesn't delete the user accounts. It only removes them from the group.

API Stability Long-Term
Security Requirement & Control ManageUsers API permission

Syntax

graphql
removeUsersFromGroup(
      input: RemoveUsersFromGroupInput!
   ): RemoveUsersFromGroupMutation!

For the input, you will need to give the unique identifier of the group (click on Show Query above for an example of how to get this). You'll also have to enter a comma-separated list of user names. Click on Show Query above to find these items.

For the results, you can get plenty details on the group, in particular a list of remaining users. See the Returned Values section for more details.

Example

Raw
graphql
mutation {
  removeUsersFromGroup(input: 
         { groupId: "abc123",
           users: ["bob", "tom"] } )
    { group {displayName, userCount} }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  removeUsersFromGroup(input: 
         { groupId: \"abc123\",
           users: [\"bob\", \"tom\"] } )
    { group {displayName, userCount} }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  removeUsersFromGroup(input: 
         { groupId: \"abc123\",
           users: [\"bob\", \"tom\"] } )
    { group {displayName, userCount} }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  removeUsersFromGroup(input:  ^
         { groupId: \"abc123\", ^
           users: [\"bob\", \"tom\"] } ) ^
    { group {displayName, userCount} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  removeUsersFromGroup(input: 
         { groupId: \"abc123\",
           users: [\"bob\", \"tom\"] } )
    { group {displayName, userCount} }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  removeUsersFromGroup(input: 
         { groupId: \"abc123\",
           users: [\"bob\", \"tom\"] } )
    { group {displayName, userCount} }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  removeUsersFromGroup(input: 
         { groupId: \"abc123\",
           users: [\"bob\", \"tom\"] } )
    { group {displayName, userCount} }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  removeUsersFromGroup(input: 
         { groupId: \"abc123\",
           users: [\"bob\", \"tom\"] } )
    { group {displayName, userCount} }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "addUsersToGroup": {
      "group": {
        "displayName": "Maintainers",
        "userCount": 5
      }
    }
  }
}

Input Parameters

For the input, you'll have to give the unique identifier for the group, and a list of users to remove from that group. For an example of how to get the group identifier and user names, click on Show Query above the Syntax section.

Table: RemoveUsersFromGroupInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 19, 2024
groupIdstringyes Long-TermThe unique identifier of the group from which users should be removed.
users[string]yes Long-TermA list of users to remove from the group.

Returned Values

For the results, you can get plenty on the group. What may be most of interest to you with this mutation is the users sub-option to get a list of remaining users. Click on the link in the table below to the sub-datatype for more details:

Table: RemoveUsersFromGroupMutation Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: May 26, 2025
groupGroupyes Long-TermThe group from which to remove users from the mutation. See Group.