assignOrganizationRoleToGroup()

API Stability	`Long-Term`

The assignOrganizationRoleToGroup() 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.

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

assignOrganizationManagementRoleToGroup(
       input: AssignOrganizationManagementRoleToGroupInput!
    ): AssignOrganizationManagementRoleToGroupMutation!

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

Show:

graphql

mutation {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: "0dVscp645a6lCbe1WuJxjPbRRF5uBMD5", 
             roleId: "wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB",
             organizationIds: ["SINGLE_ORGANIZATION_ID"]} )
       { group { role {displayName, organizationPermissions} } }
}

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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}
EOF

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: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  assignOrganizationManagementRoleToGroup(input:  ^
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\",  ^
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\", ^
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} ) ^
       { group { role {displayName, organizationPermissions} } } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {displayName, organizationPermissions} } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\",
             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)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  assignOrganizationManagementRoleToGroup(input: 
            {groupId: \"0dVscp645a6lCbe1WuJxjPbRRF5uBMD5\", 
             roleId: \"wZ5KEIUY7kRFYDxlQZCHB72VZnFGsmIB\",
             organizationIds: [\"SINGLE_ORGANIZATION_ID\"]} )
       { group { role {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();

Given Datatypes

For AssignOrganizationManagementRoleToGroupInput, there are a few parameters. Below is a list of them:

Table: AssignOrganizationManagementRoleToGroupInput

Parameter	Type	Required	Description
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 for the group.
`organizationIds`	[string]	yes	The unique identifier for the organization.
`roleId`	string	yes	The unique identifier for the rpòe.

Returned Datatypes

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

Table: AssignOrganizationManagementRoleToGroupMutation

Parameter	Type	Required	Stability	Description
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
`text`	`GroupOrganizationManagementRole`	yes	`Long-Term`	The organization role to assign to group. See `GroupOrganizationManagementRole`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes