Users can be members of multiple groups and you can create many groups based on your needs. At some point, though, you may decide that you have too many groups, or some may be redundant. At which point, you can use the removeGroup() GraphQL mutation to delete a group from LogScale. This only deletes the group and its settings — not the user accounts and roles. Incidentally, this mutation is only usable, though, if roles are not managed externally (e.g., in LDAP).

To rename 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.

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

Syntax

graphql
removeGroup(
      groupId: string!
   ): RemoveGroupMutation!

You'll have to give the unique identifier of the group. You can get that with the groupByDisplayName() query, if you know the name of the group. Otherwise, you can use groupsPage() (click on Show Query below for an example).

For the results, you'll basically get confirmation of success or not. See the Returned Datatype section for more clarity.

Hide Query Example

Show Group Identifiers Query

Example

Raw
graphql
mutation {
  removeGroup(
    groupId: "abc123"
  )
  {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: \"abc123\"
  )
  {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: \"abc123\"
  )
  {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: \"abc123\" ^
  ) ^
  {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: \"abc123\"
  )
  {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: \"abc123\"
  )
  {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: \"abc123\"
  )
  {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: \"abc123\"
  )
  {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 only get the unique identifier of the deleted group. You would select that by way of the group parameter and the id sub-parameter.

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.