The assignRoleToGroup() GraphQL mutation assigns a role to a group for a given view.

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 assignRoleToGroup() mutation field:

graphql
assignRoleToGroup(
      input: AssignRoleToGroupInput!
   ): AssignRoleToGroupMutation!

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

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

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 {
  assignRoleToGroup(input: 
          { viewId: \"aK9GKAsTnMXfRxT8Fpecx3fX\",
            groupId: \"Kj3SzghhYxdjz8X6XIxZ2EhaVTrMuSpo\", 
            roleId: \"pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2\"} )
     { group { role {id, displayName, viewPermissions} } }
}"
}
);


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": {
    "assignRoleToGroup": {
      "group": {
        "role": {
          "id": "pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2",
          "displayName": "Member",
          "viewPermissions": [
            "ChangeDashboards",
            "ChangeSavedQueries",
            "ChangeTriggers",
            "ChangeFiles",
            "ChangeParsers",
            "ReadAccess"
          ]
        }
      }
    }
  }
}

Given Datatypes

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

Table: AssignRoleToGroupInput

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
groupIdstringyes The unique identifier of the group being assigned.
overrideExistingAssignmentsForViewboolean  Whether to override any existing assignments for a view.
roleIdstringyes The unique identifier of the role being assigned.
viewIdstringyes Name of the view of the alert.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the input type, AssignRoleToGroupMutation. This datatype includes one parameters for values that may be returned:

Table: AssignRoleToGroupMutation

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
groupSearchDomainRoleyes The group for which to assign role. See SearchDomainRole.