API Stability Long-Term

The assignSystemRoleToGroup() GraphQL mutation may be used to assign a system role to a group.

To unassign a system role from a group, use the unassignSystemRoleFromGroup() mutation. Related to these two mutations are a few others: assignRoleToGroup() and unassignRoleFromGroup() to assign and unassign a role for a group; assignOrganizationRoleToGroup() and unassignOrganizationRoleFromGroup() to assign and unassign organization roles; and assignOrganizationManagementRoleToGroup() and unassignOrganizationManagementRoleFromGroup() for organization management roles.

Hide Query Example

Show Group Roles Query

For more information on roles in LogScale, see the Manage Users and Permissions documentation page. You may also want to look at Manage Users and Permissions for related information.

Syntax

graphql
assignSystemRoleToGroup(
      input: AssignSystemRoleToGroupInput!
   ): AssignSystemRoleToGroupMutation!

Example

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

Raw
graphql
mutation {
  assignSystemRoleToGroup(input: 
          { groupId: "Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo", 
            roleId: "pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2"} )
     { group { role {id, displayName, viewPermissions} } }
}
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 {
  assignSystemRoleToGroup(input: 
          { groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\", 
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} )
     { group { role {id, displayName, viewPermissions} } }
}"
}
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 {
  assignSystemRoleToGroup(input: 
          { groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\", 
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} )
     { group { role {id, displayName, viewPermissions} } }
}"
}
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 { ^
  assignSystemRoleToGroup(input:  ^
          { groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\",  ^
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} ) ^
     { group { role {id, displayName, viewPermissions} } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  assignSystemRoleToGroup(input: 
          { groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\", 
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} )
     { group { role {id, displayName, viewPermissions} } }
}"
}'
    "$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 {
  assignSystemRoleToGroup(input: 
          { groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\", 
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} )
     { group { role {id, displayName, viewPermissions} } }
}";
$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 {
  assignSystemRoleToGroup(input: 
          { groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\", 
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} )
     { group { role {id, displayName, viewPermissions} } }
}"
}'''

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 {
  assignSystemRoleToGroup(input: 
          { groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\", 
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} )
     { group { role {id, displayName, viewPermissions} } }
}"
}
);


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": {
    "assignSystemRoleToGroup": {
      "group": {
        "role": {
          "id": "pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2",
          "displayName": "Member",
          "viewPermissions": [
            "ChangeDashboards",
            "ChangeSavedQueries",
            "ChangeTriggers",
            "ChangeFiles",
            "ChangeParsers",
            "ReadAccess"
          ]
        }
      }
    }
  }
}

Given Datatype

For the given datatype, you'll need to provide the unique identifiers for the role and the group — the role you want to assign to which group. The table below lists the parameters of this datatype and descriptions of them:

Table: AssignSystemRoleToGroupInput

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 17, 2024
groupIdstringyes Long-TermThe unique identifier of the group being assigned.
roleIdstringyes Long-TermThe unique identifier of the role being assigned.

Returned Datatype

With the returned datatype, through sub-parameters, you can get plenty of information about the roles found in the organization, including user names and counts, as well as permissions and assets. The table below lists links to these sub-parameters:

Table: AssignSystemRoleToGroupMutation

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
groupGroupSystemRoleyes Long-TermThe group for which to assign system role. See GroupSystemRole.