The roles() GraphQL query will retrieve a list of all of the defined roles.

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

Syntax

Below is the syntax for the roles() query field:

graphql
roles: [Role!]!

There's no input for this query field. However, since there are so many possible parameters that may be returned, you'll have to enter the ones you want within curly-brackets, as you can see in the example below:

Raw
graphql
query {
    roles {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" : "query {
    roles {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" : "query {
    roles {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" : "query { ^
    roles {id, displayName,  ^
           organizationPermissions} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
    roles {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" : "query {
    roles {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" : "query {
    roles {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" : "query {
    roles {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": {
    "roles": [
      {
        "id": "pFLOxe7C8zkNbWOSP8VartJ0I6Kz0eK2",
        "displayName": "Member",
        "organizationPermissions": []
      },
      {
        "id": "8TKAG5afPxvPcqGJ8De8ccMeJSFiBckE",
        "displayName": "OrgManager",
        "organizationPermissions": [
          "ChangeIPFilters",
          "DeleteAllViews",
          "DeleteAllRepositories",
          "ChangeSecurityPolicies",
          "ChangeOrganizationPermissions",
          "ViewAllInternalNotifications",
          "ChangeSessions",
          "ManageViewConnections",
          "IngestAcrossAllReposWithinOrganization",
          "ChangeFieldAliases",
          "CreateRepository",
          "ManageUsers",
          "ViewUsage",
          "ChangeTriggersToRunAsOtherUsers",
          "ViewFleetManagement",
          "ChangeAllViewOrRepositoryPermissions",
          "ChangeFleetManagement"
        ]
      }
    ...  
    ]
  }
}

Returned Datatypes

The returned datatype role has several parameters. Below is a list of them along with a description of each:

Table: Role

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.
colorstring  The color associated with the role.
descriptionstring  A description of the role.
displayNamestringyes The display name of the role.
groupsGroupyes The groups related to the role. See Group.
groupsV2multipleyes The groups related to the role. The multiple datatype consists of (search: string, userId: string, searchInRoles: boolean, onlyIncludeGroupsWithRestrictiveQueryPrefix: boolean, limit: integer, skip: integer): GroupResultSetType. See GroupResultSetType.
idstringyes The unique identifier for the role.
organizationPermissionsOrganizationPermissionyes The organization permissions given to the role. See OrganizationPermission.
groupsCountintegeryes The number of groups related to the role.
systemPermissionsSystemPermissionyes The system permissions given to the role. See SystemPermission.
users[User]yes A list of users assigned the role. See User.
usersCountintegeryes The number of users assigned the role.
viewPermissionsPermissionyes The view permissions given to the role. See Permission.