Security Requirements and Controls
API Stability Long-Term

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

To make changes instead to a group, use the updateGroup() mutation. To create a new one, use addGroup(). For a list of groups, use the groupsPage() query. To get details on a group, use group().

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

Syntax

graphql
removeGroup(
      groupId: string!
   ): RemoveGroupMutation!

There is no special input datatype for this mutation field. To be able to provide the groupId , you'll have to get 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 Datatype 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.

Example

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

Raw
graphql
mutation {
  removeGroup(
    groupId: "S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij"
  )
  {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 {
  removeGroup(
    groupId: \"S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij\"
  )
  {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 {
  removeGroup(
    groupId: \"S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij\"
  )
  {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 { ^
  removeGroup( ^
    groupId: \"S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij\" ^
  ) ^
  {group {displayName, userCount}} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  removeGroup(
    groupId: \"S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij\"
  )
  {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 {
  removeGroup(
    groupId: \"S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij\"
  )
  {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 {
  removeGroup(
    groupId: \"S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij\"
  )
  {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 {
  removeGroup(
    groupId: \"S9fNVnryg8d1Ql7LgewXi1PlnvCIJjij\"
  )
  {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": {
    "removeGroup": {
      "group": {
        "displayName": "Gang",
        "userCount": 0
      }
    }
  }
}

Returned Datatype

For the return datatype, you can get information on the group's users, such as how many, a list of them, and which assets they can access. You can also get a list of roles and what they entail. These parameters are described below, in addition to links to sub-parameters:

Table: RemoveGroupMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 3, 2024
groupGroupyes Long-TermThe group associated with the mutation. See Group.