The updateRole() GraphQL mutation is used to update a role in LogScale.

For more information on roles in LogScale, see the Managing Users & Permissions documentation page. You may also want to look at the Managing Users & Permissions page for related information.

Syntax

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

updateRole(input: UpdateRoleInput!): UpdateRoleMutation!

Given Datatypes

For the given datatype, UpdateRoleInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: UpdateRoleInput

ParameterTypeRequired[a]DefaultDescription
roleIdstringyes The unique identifier of the role to update.
displayNamestringyes The display name of the role to update.
viewPermissions[Permission]yes A list of permissions associated with the view (see Permission Table).
descriptionstring  The description of the role to update.
colorstring  The color for displaying the role.
systemPermissions[SystemPermission]yes List of permissions given for users who are assigned the role (see SystemPermission Table).
organizationPermissions[OrganizationPermission]yes List of permissions given for organization users who are assigned the role (see OrganizationPermission Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

The returned datatype UpdateRoleMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UpdateRoleMutation

ParameterTypeRequired[a]DefaultDescription
roleRoleyes The role to update (see Role Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.