The updateGroup()
For more information on user groups, see the
Manage Groups documentation page.
Below is the syntax for the
updateGroup()
updateGroup(
input : UpdateGroupInput!
) : UpdateGroupMutation!
Below is an example of how this mutation field might be used:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw mutation {
updateGroup( input :
{ groupId : "sQjSEU6MDp6W9HrwAejmL9yHJlk6Q1sp" ,
displayName : "cool-kids"
}
)
{ group { userCount } }
} Mac OS or Linux (curl) 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 } }
}"
}
EOFMac OS or Linux (curl) One-line 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 } }
}"
}
EOFWindows Cmd and curl 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 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
use HTTP::Request;
use LWP;
my $INGEST_TOKEN = "TOKEN" ;
my $uri = '$YOUR_LOGSCALE_URL/graphql' ;
my $json = '{"query" : "mutation {
updateGroup( input:
{ groupId: \"sQjSEU6MDp6W9HrwAejmL9yHJlk6Q1sp\",
displayName: \"cool-kids\"
}
)
{ group { userCount } }
}"
}' ;
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
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 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/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 Show:
Success (HTTP Response Code 200 OK)
Success (HTTP Response Code 200 OK) {
"data" : {
"updateGroup" : {
"group" : {
"userCount" : 6
}
}
}
}
For UpdateGroupInput ,
there are a few parameters that may be given. Below is a list of
them along with a description of each:
The returned datatype
UpdateGroupMutation has
one parameter, and several sub-parameters. Click below on the name
of the parameter to see the table with the sub-parameters:
Table: UpdateGroupMutation
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required Table last updated: Apr 2, 2025 groupGroupyes Long-TermThe group to update. See Group
