Security Requirements and Controls
API Stability Preview

The assignOrganizationManagementRoleToGroup() GraphQL mutation field is used to assign an organization management role to a group for the provided organizations. This is a preview and subject to change.

To unassign an organization management role from a group, use the unassignOrganizationManagementRoleFromGroup() 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() for general organization roles for a group; and assignSystemRoleToGroup() and unassignSystemRoleFromGroup() to assign and unassign system roles.

Hide Query Example

Show Management Permissions 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
assignOrganizationManagementRoleToGroup(
       input: AssignOrganizationManagementRoleToGroupInput!
    ): AssignOrganizationManagementRoleToGroupMutation!

Example

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

Raw
graphql
mutation {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: "abc123", 
             roleId: "def456",
             organizationIds: ["SINGLE_ORGANIZATION_ID"]} )
       { group { role {displayName, organizationPermissions} } }
}
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 {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"abc123\", 
             roleId: \"def456\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}
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 {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"abc123\", 
             roleId: \"def456\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}
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 { ^
  assignOrganizationManagementRoleToGroup(input:  ^
            {groupId: \"abc123\",  ^
             roleId: \"def456\", ^
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} ) ^
       { group { role {displayName, organizationPermissions} } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"abc123\", 
             roleId: \"def456\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}'
    "$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 {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"abc123\", 
             roleId: \"def456\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}";
$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 {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"abc123\", 
             roleId: \"def456\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}'''

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 {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"abc123\", 
             roleId: \"def456\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}
);


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": {
    "assignOrganizationManagementRoleToGroup": {
      "group": {
      "role": { 
          displayName": "sales",
          organizationPermissions": [
             "MonitorQueries", 
             "BlockQueries"
             ]
        } 
      }
    }
  }
}

Given Datatype

For the given datatype, you'll need to provide the unique identifer of the group and role to assign, along with a list of organizations you're assigning them. The table below lists provides more details:

Table: AssignOrganizationManagementRoleToGroupInput

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 PreviewThe unique identifier for the group.
organizationIds[string]yes PreviewThe unique identifier for the organization.
roleIdstringyes PreviewThe unique identifier for the role.

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: AssignOrganizationManagementRoleToGroupMutation

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: May 26, 2025
groupGroupOrganizationManagementRoleyes Long-TermThe organization role to assign to group. See GroupOrganizationManagementRole.