The assignOrganizationRoleToGroup() GraphQL mutation field is used to assign an organization role to a group. This field is not yet available. It's described here as a preview.

This is an experimental feature, not ready for production.

For more information on roles in LogScale, see the Manage users & permissions documentation page. You may also want to look at Manage users & permissions for related information.

Syntax

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

graphql
assignOrganizationRoleToGroup(
       input: AssignOrganizationRoleToGroupInput!
    ): AssignOrganizationRoleToGroupMutation!

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

Raw
graphql
mutation {
  assignOrganizationRoleToGroup(input: 
            {groupId: "0dVscp645a6lCbe1WuJxjPbRRF5uBMD5", 
             roleId: "wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB"} )
       { group { role {id, 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 {
  assignOrganizationRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\"} )
       { group { role {id, 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 {
  assignOrganizationRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\"} )
       { group { role {id, 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 { ^
  assignOrganizationRoleToGroup(input:  ^
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",  ^
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\"} ) ^
       { group { role {id, displayName, organizationPermissions} } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  assignOrganizationRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\"} )
       { group { role {id, displayName, organizationPermissions} } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  assignOrganizationRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\"} )
       { group { role {id, displayName, organizationPermissions} } }
}"
}';
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 {
  assignOrganizationRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\"} )
       { group { role {id, 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 {
  assignOrganizationRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\"} )
       { group { role {id, displayName, organizationPermissions} } }
}"
}
);


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": {
    "assignOrganizationRoleToGroup": {
      "group": {
        "role": {
          "id": "wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB",
          "displayName": "Maintainer",
          "organizationPermissions": [
            "ChangeSecurityPolicies",
            "ManageUsers",
            "ChangeOrganizationPermissions",
            "ChangeSessions",
            "ChangeAllViewOrRepositoryPermissions"
          ]
        }
      }
    }
  }
}

Given Datatypes

For the input (i.e., AssignOrganizationRoleToGroupInput), there are a couple of parameters that may be given. Below is a list of them along with their data type and a description of each:

Table: AssignOrganizationRoleToGroupInput

ParameterTypeRequiredDefaultDescription
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 17, 2024
groupId[string]yes The unique identifier of the group.
roleIdstring  The unique identifier of the role.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, AssignOrganizationRoleToGroupMutation. Below is the parameter of that datatype:

Table: AssignOrganizationRoleToGroupMutation

ParameterTypeRequiredDefaultDescription
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 23, 2024
groupGroupOrganizationRoleyes The group to which to assign orgnization role. See GroupOrganizationRole.