unassignRoleFromGroup()

Summary

The unassignRoleFromGroup() GraphQL mutation may be used to remove a role assigned to a group for a given view.

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

Hide Query Example

Show Group Roles Query

To get a list of group roles, you could execute the group() query like this:

graphql

query {
     group( groupId: "def456" ) 
       { roles 
         { role { id, displayName, 
                  systemPermissions,
                  users { username } }
         }
     }
}

The query above will return a list of roles for the group, the system permissions of each, and the usernames of those who are part of the group.

For more information on roles in LogScale, see the Manage Users and Permissions documentation page. To unassign roles from a group with the user interface instead of GraphQL, see Assign Roles to Groups.

API Stability Long-Term

Syntax

graphql

unassignRoleFromGroup(
      input: RemoveRoleFromGroupInput!
   ): UnassignRoleFromGroup!

For the input, you'll have to get the unique identifiers for the view, the role, and the group. Click on Show Query above to get the identifiers. See the Input Parameters section for details.

For the results, you can get a list of groups, a list of roles, etc. See the Returned Values section for more.

Example

Raw

graphql

mutation {
  unassignRoleFromGroup(input: 
          { viewId: "abc123",
            groupId: "def456", 
            roleId: "ghi789"} )
     { group { 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 {
  unassignRoleFromGroup(input: 
          { viewId: \"abc123\",
            groupId: \"def456\", 
            roleId: \"ghi789\"} )
     { group { 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 {
  unassignRoleFromGroup(input: 
          { viewId: \"abc123\",
            groupId: \"def456\", 
            roleId: \"ghi789\"} )
     { group { 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 { ^
  unassignRoleFromGroup(input:  ^
          { viewId: \"abc123\", ^
            groupId: \"def456\",  ^
            roleId: \"ghi789\"} ) ^
     { group { userCount } } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  unassignRoleFromGroup(input: 
          { viewId: \"abc123\",
            groupId: \"def456\", 
            roleId: \"ghi789\"} )
     { group { 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 {
  unassignRoleFromGroup(input: 
          { viewId: \"abc123\",
            groupId: \"def456\", 
            roleId: \"ghi789\"} )
     { group { 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 {
  unassignRoleFromGroup(input: 
          { viewId: \"abc123\",
            groupId: \"def456\", 
            roleId: \"ghi789\"} )
     { group { 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 {
  unassignRoleFromGroup(input: 
          { viewId: \"abc123\",
            groupId: \"def456\", 
            roleId: \"ghi789\"} )
     { group { 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": {
    "unassignRoleFromGroup": {
      "group": {
        "userCount": 6
      }
    }
  }
}

Input Parameters

For the input, you'll need to provide the unique identifiers for the view, the role, and the group — the view containing which role you want to unassign from which group. Click on the Show Query link above the Syntax section for an example of how to find the identifiers.

Table: RemoveRoleFromGroupInput Input Datatype

Parameter	Type	Required	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 19, 2024
groupId	string	yes	`Long-Term`	The unique identifier of the group.
roleId	string	yes	`Long-Term`	The unique identifier of the role to remove from the group.
viewId	string	yes	`Long-Term`	The unique identifier of the view associated with the role.

Returned Values

For the results, 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 roles using roles.

Table: UnassignRoleFromGroup Datatype

Parameter	Type	Required	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 4, 2024
group	Group	yes	`Long-Term`	The unassigned group. See Group.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes