Security Requirements and Controls
API Stability Long-Term

The updateDefaultRole() GraphQL mutation is used to update the default role for 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 the Manage Users and Permissions page for related information. In particular, read the section on groups, Manage Groups.

Syntax

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

graphql
updateDefaultRole(
      input: UpdateDefaultRoleInput!
   ): updateDefaultRoleMutation!

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/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": {
    "updateDefaultRole": {
      "group": {
        "displayName": "sales"
      }
    }
  }
}

Given Datatypes

For UpdateDefaultRoleInput, there are a couple of parameters. Below is a list of them along with a description of each:

Table: UpdateDefaultRoleInput

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 23, 2024
groupIdstringyes Long-TermThe unique identifier of the group.
roleIdstring  Long-TermThe unique identifier of the default role to update.

Returned Datatypes

The returned datatype updateDefaultRoleMutation has one parameter, but several sub-parameters. Click on the link below for the one parameter to see the table with the sub-parameters:

Table: updateDefaultRoleMutation

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 for which to update the default role. See Group.