The updateRole() GraphQL mutation is used to update a user role in LogScale. This includes changing the permissions granted to users assigned the role.

To change which role is the default one, use updateDefaultRole(). To make a new role, you would use the createRole() mutation. To delete a role, use removeRole().

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

For more information in general on user accounts in LogScale, see the Manage Users and Permissions documentation page. For more on user roles, see the Manage Roles and Edit a user role pages.

API Stability Long-Term
Security Requirement & Control ManageUsers API permission

Syntax

graphql
updateRole(
     input: UpdateRoleInput!
   ): UpdateRoleMutation!

For the input, you'll have to give the role's identifier, the display name, the permissions assigned the role, and whatever else you want to change. You can use the roles() query to get the identifier. See the Given Datatype section for details.

For the results, you can get a list of users and roles. See the Returned Datatype section for more.

Example

Raw
graphql
mutation {
  updateRole( input:
    { roleId: "abc123",
      displayName: "Testers",
      viewPermissions: [ ChangeDashboards, ReadAccess ]
    }
  )
  { role { usersCount } }
}
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 {
  updateRole( input:
    { roleId: \"abc123\",
      displayName: \"Testers\",
      viewPermissions: [ ChangeDashboards, ReadAccess ]
    }
  )
  { role { usersCount } }
}"
}
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 {
  updateRole( input:
    { roleId: \"abc123\",
      displayName: \"Testers\",
      viewPermissions: [ ChangeDashboards, ReadAccess ]
    }
  )
  { role { usersCount } }
}"
}
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 { ^
  updateRole( input: ^
    { roleId: \"abc123\", ^
      displayName: \"Testers\", ^
      viewPermissions: [ ChangeDashboards, ReadAccess ] ^
    } ^
  ) ^
  { role { usersCount } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateRole( input:
    { roleId: \"abc123\",
      displayName: \"Testers\",
      viewPermissions: [ ChangeDashboards, ReadAccess ]
    }
  )
  { role { usersCount } }
}"
}'
    "$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 {
  updateRole( input:
    { roleId: \"abc123\",
      displayName: \"Testers\",
      viewPermissions: [ ChangeDashboards, ReadAccess ]
    }
  )
  { role { usersCount } }
}";
$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 {
  updateRole( input:
    { roleId: \"abc123\",
      displayName: \"Testers\",
      viewPermissions: [ ChangeDashboards, ReadAccess ]
    }
  )
  { role { usersCount } }
}"
}'''

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 {
  updateRole( input:
    { roleId: \"abc123\",
      displayName: \"Testers\",
      viewPermissions: [ ChangeDashboards, ReadAccess ]
    }
  )
  { role { usersCount } }
}"
}
);


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": {
    "updateRole": {
      "role": {
        "usersCount": 6
      }
    }
  }
}

Given Datatype

For this input datatype, you'll have to give the unique identifier of the role you want to update, the display name, the permissions assigned the role, and whatever else you want to change. You can use the roles() query to get the identifier.

Table: UpdateRoleInput

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: Aug 18, 2025
colorstring  Long-TermThe color for displaying the role.
descriptionstring  Long-TermThe description of the role to update.
displayNamestringyes Long-TermThe display name of the role to update.
objectActionObjectAction  Long-TermThe object of the action. See ObjectAction.
organizationManagementPermissions[OrganizationManagementPermission]  Long-TermList of permissions given for organization management. See OrganizationManagementPermission.
organizationPermissions[OrganizationPermission]  Long-TermList of permissions given for the organization. See OrganizationPermission.
roleIdstringyes Long-TermThe unique identifier of the role to update.
systemPermissions[SystemPermission]  Long-TermList of permissions given for users who are assigned the role. See SystemPermission.
viewPermissions[Permission]yes Long-TermA list of permissions associated with the view. See Permission.

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. The table below contains a link to another table with the sub-parameters:

Table: UpdateRoleMutation

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
roleRoleyes Long-TermThe role to update. See Role.