The removeGroup() GraphQL mutation may be used to removes a group from LogScale. Only usable if roles are not managed externally (e.g., in LDAP).

For more information on user groups, see the Manage Groups documentation page.

Syntax

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

graphql
removeGroup(
      groupId: string!
   ): RemoveGroupMutation!

To be able to provide the groupId, you'll have to gete the unique identifier for the group. You can get that with the groupByDisplayName() , if you know the name of the group.

For the return value RemoveGroupMutation, you'll need to specify its only parameter, group (see the Returned Datatypes section below). But then you'll have to specify one of its parameters: id is the main one you'll need since it's key to getting and changing anything else for the group. See the example below for more clarity:

Raw
graphql
mutation{
  removeGroup(groupId: "BHdJstvjgDUjXg10KrbjiybpSbOHIw1b")
    {
      group { id }
    } 
}
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{
  removeGroup(groupId: \"BHdJstvjgDUjXg10KrbjiybpSbOHIw1b\")
    {
      group { id }
    } 
}"
}
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{
  removeGroup(groupId: \"BHdJstvjgDUjXg10KrbjiybpSbOHIw1b\")
    {
      group { id }
    } 
}"
}
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{ ^
  removeGroup(groupId: \"BHdJstvjgDUjXg10KrbjiybpSbOHIw1b\") ^
    { ^
      group { id } ^
    }  ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation{
  removeGroup(groupId: \"BHdJstvjgDUjXg10KrbjiybpSbOHIw1b\")
    {
      group { id }
    } 
}"
}'
"$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation{
  removeGroup(groupId: \"BHdJstvjgDUjXg10KrbjiybpSbOHIw1b\")
    {
      group { id }
    } 
}"
}';
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{
  removeGroup(groupId: \"BHdJstvjgDUjXg10KrbjiybpSbOHIw1b\")
    {
      group { id }
    } 
}"
}'''

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{
  removeGroup(groupId: \"BHdJstvjgDUjXg10KrbjiybpSbOHIw1b\")
    {
      group { id }
    } 
}"
}
);


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": {
    "removeGroup": {
      "group": {
        "id": "BHdJstvjgDUjXg10KrbjiybpSbOHIw1b"
      }
    }
  }
}

Returned Datatypes

The returned datatype RemoveGroupMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: RemoveGroupMutation

ParameterTypeRequiredDefaultDescription
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: Oct 3, 2024
groupGroupyes The group associated with the mutation. See Group.