API Stability Long-Term

The unassignOrganizationRoleFromGroup() GraphQL mutation field is used to remove an organization role assigned to a group in LogScale.

For more information on roles in LogScale, see the Manage Users and Permissions documentation page. You may also want to look at Manage Groups for related information.

Syntax

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

graphql
unassignOrganizationRoleFromGroup(
      input: RemoveOrganizationRoleFromGroupInput!
   ): UnassignOrganizationRoleFromGroup!

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

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

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 {
  unassignOrganizationRoleFromGroup( input:
    { groupId: \"abc123\",
      roleId: \"def456\"
    } )
  { group { displayName } }
}"
}
);


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 the given datatype, RemoveOrganizationRoleFromGroupInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: RemoveOrganizationRoleFromGroupInput

ParameterTypeRequiredDefaultStabilityDescription
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 19, 2024
groupIdstringyes Long-TermThe unique identifier of the group from which the organization should be removed.
roleIdstringyes Long-TermThe unique identifier of the role for the group of the organization.

Returned Datatypes

The returned datatype UnassignOrganizationRoleFromGroup has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UnassignOrganizationRoleFromGroup

ParameterTypeRequiredDefaultStabilityDescription
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: Oct 4, 2024
groupGroupyes Long-TermThe group without an assigned organization. See Group.