API Stability Long-Term

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

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

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

graphql
unassignSystemRoleFromGroup(
      input: RemoveSystemRoleFromGroupInput!
   ): UnassignSystemRoleFromGroup!

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/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": {
    "unassignSystemRoleFromGroup": {
      "group": {
        "displayName": "Sales Dept.",
        "userCount": 6
      }
    }
  }
}

Given Datatypes

For the given datatype, RemoveSystemRoleFromGroupInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: RemoveSystemRoleFromGroupInput

ParameterTypeRequiredDefaultStabilityDescription
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 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 Datatypes

The returned datatype UnassignSystemRoleFromGroup has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UnassignSystemRoleFromGroup

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