API Stability Long-Term

The unassignSystemRoleFromGroup() GraphQL mutation field may be used to remove a system role assigned to a group in LogScale.

To assign a system role to a group, use the assignSystemRoleToGroup() 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.

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

Syntax

graphql
unassignSystemRoleFromGroup(
      input: RemoveSystemRoleFromGroupInput!
   ): UnassignSystemRoleFromGroup!

Example

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

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

Given Datatype

For the input datatype, you'll need to provide the unique identifiers for the role and the group — the system role you want to unassign from which group. The table below lists these parameters and describes them:

Table: RemoveSystemRoleFromGroupInput

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 19, 2024
groupIdstringyes Long-TermThe unique identifier of the group.
roleIdstringyes Long-TermThe unique identifier of the system role to remove from 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 system roles using the systemRoles parameter. The table below contains a link to another table with the sub-parameters:

Table: UnassignSystemRoleFromGroup

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 4, 2024
groupGroupyes Long-TermThe group from which to unassign the system role. See Group.