Security Requirements and Controls
API Stability Long-Term

The removeUsersFromGroup() GraphQL mutation is used to remove users from a group in LogScale.

For more information on user authorization, see the Manage Users and Permissions documentation page. In particular, read the section on groups, Manage Groups.

Syntax

Below is the syntax for the removeUsersFromGroup() mutation field:

graphql
removeUsersFromGroup(
      input: RemoveUsersFromGroupInput!
   ): RemoveUsersFromGroupMutation!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  removeUsersFromGroup(input: 
         { groupId: "0dVscp645a6lCbe1WuJxjPbRRF5uBMD5",
           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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", ^
           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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           users: [\"bob\", \"tom\"] } )
    { group {displayName, userCount} }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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
      }
    }
  }
}

Given Datatypes

For RemoveUsersFromGroupInput, there a couple of parameters. Below is a list of them along with a description of each:

Table: RemoveUsersFromGroupInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
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 Datatypes

RemoveUsersFromGroupMutation has one parameter, but several sub-parameters. Click on the link in the table below to see them.

Table: RemoveUsersFromGroupMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: May 26, 2025
groupGroupyes Long-TermThe group from which to remove users from the mutation. See Group.