Security Requirements and Controls
API Stability Long-Term

The updateDefaultRole() GraphQL mutation is used to update the default role for a group in LogScale.

Related to this mutation, there are the mutations createRole(), and removeRole() for creating and removing a role.

For getting information about a given role, there is the role() query. There are also the roles() and rolesPage() queries to get a list of roles.

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

Syntax

graphql
updateDefaultRole(
      input: UpdateDefaultRoleInput!
   ): updateDefaultRoleMutation!

Example

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

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

Given Datatype

For the input datatype, you'll have to provide the unique identifier of the group, and the default role. These are described below:

Table: UpdateDefaultRoleInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 23, 2024
groupIdstringyes Long-TermThe unique identifier of the group.
roleIdstring  Long-TermThe unique identifier of the default role to update.

Returned Datatype

For the return datatype, through sub-parameters, you can get information on the group, such as how many users, a list of them, and which assets they can access. You can also get a list of roles using the roles parameter and the default role with defaultRole. The table below contains a link to another table with the sub-parameters:

Table: updateDefaultRoleMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 4, 2024
groupGroupyes Long-TermThe group for which to update the default role. See Group.