Security Requirements and Controls
API Stability Long-Term

The updateGroup() GraphQL mutation may be used to update a given group in LogScale.

To create a new group, use the addGroup() mutation. To delete a group, use removeGroup(). 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
updateGroup(
      input: UpdateGroupInput!
   ): UpdateGroupMutation!

Example

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

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

Given Datatype

For this input datatype, you'll have to give the unique identifier of the group to update, and possibly the new display name or lookup name. The table below provides more details:

Table: UpdateGroupInput

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: Sep 23, 2024
displayNamestring  Long-TermThe display name for the group.
groupIdstringyes Long-TermThe unique identifier of the group to update.
lookupNamestring  Long-TermThe lookup name for the group.

Returned Datatype

For the return datatype, through sub-parameters, you can get information on the group, such as how many users, 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: UpdateGroupMutation

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: Apr 2, 2025
groupGroupyes Long-TermThe group to update. See Group.