The addUsersToGroup() GraphQL mutation is used to add users to an existing group.

For more information on user authorization, see the Manage users & permissions documentation page. In particular, read the section on groups, Manage Groups.

Syntax

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

graphql
addUsersToGroup(
      input: AddUsersToGroupInput!
   ): AddUsersToGroupMutation!

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

Raw
graphql
mutation {
  addUsersToGroup(input: 
         { groupId: "0dVscp645a6lCbe1WuJxjPbRRF5uBMD5",
           users: ["tom", "wilbur"] } )
    { 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 {
  addUsersToGroup(input: 
         { groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           users: [\"tom\", \"wilbur\"] } )
    { 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 {
  addUsersToGroup(input: 
         { groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           users: [\"tom\", \"wilbur\"] } )
    { 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 { ^
  addUsersToGroup(input:  ^
         { groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", ^
           users: [\"tom\", \"wilbur\"] } ) ^
    { group {displayName, userCount} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addUsersToGroup(input: 
         { groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           users: [\"tom\", \"wilbur\"] } )
    { group {displayName, userCount} }
}"
}'
"$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 {
  addUsersToGroup(input: 
         { groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           users: [\"tom\", \"wilbur\"] } )
    { group {displayName, 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
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  addUsersToGroup(input: 
         { groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           users: [\"tom\", \"wilbur\"] } )
    { 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 {
  addUsersToGroup(input: 
         { groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",
           users: [\"tom\", \"wilbur\"] } )
    { group {displayName, 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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "addUsersToGroup": {
      "group": {
        "displayName": "Maintainers",
        "userCount": 6
      }
    }
  }
}

Given Datatypes

For the input (i.e., AddUsersToGroupInput), there are a couple of parameters that may be given. Below is a list of them along with their datatype and a description of each:

Table: AddUsersToGroupInput

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: Sep 17, 2024
groupIdstring  The unique identifier for the group.
users[string]yes A list of user IDs to add to group.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, AddUsersToGroupMutation. Below is the parameter of that datatype:

Table: AddUsersToGroupMutation

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: Sep 23, 2024
groupGroupyes The group for which to add users. See Group.