🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The unassignOrganizationRoleFromGroup() mutation removes an organization role from a group in LogScale. Organization roles control the organization-level permissions that members of the group inherit. Revoke those permissions when the group no longer requires that level of access. The complementary assignOrganizationRoleToGroup() mutation assigns an organization role to a group.

Syntax

graphql
unassignOrganizationRoleFromGroup(
      input: RemoveOrganizationRoleFromGroupInput!
   ): UnassignOrganizationRoleFromGroup!

The mutation takes a required input argument of type RemoveOrganizationRoleFromGroupInput!. This argument identifies both the role to remove and the target group.

The mutation returns a non-null UnassignOrganizationRoleFromGroup object. This object provides data about the updated group, including its remaining organization roles.

Example

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',
  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": {
    "unassignOrganizationRoleFromGroup": {
      "group": {
        "displayName": "sales"
      }
    }
  }
}

Input parameters

Provide the unique identifiers for the role and the group through the input argument. The role identifier specifies which organization role to remove. The group identifier specifies which group loses that role. Select the Show Organization Permissions Query option in the Related section to retrieve these identifiers.

Table: RemoveOrganizationRoleFromGroupInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
groupIdStringyes Long-Term The unique identifier of the group from which the organization should be removed.
roleIdStringyes Long-Term The unique identifier of the role for the group of the organization.

Returned values

The mutation returns an UnassignOrganizationRoleFromGroup object representing the updated group. This object provides group details such as member count, member list, and accessible assets. The organizationRoles field lists the roles that remain assigned to the group after the removal.

Table: UnassignOrganizationRoleFromGroup Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
groupGroupyes Long-Term The group without an assigned organization. See Group.