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

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 updateRole() mutation field:

graphql
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[a]

ParameterTypeRequired[b]DefaultDescription
colorstring  The color for displaying the role.
descriptionstring  The description of the role to update.
displayNamestringyes The display name of the role to update.
objectActionObjectAction  The object of the action. See ObjectAction.
organizationManagementPermissions[OrganizationManagementPermission]yes List of permissions given for organization management. See OrganizationManagementPermission.
organizationPermissions[OrganizationPermission]yes List of permissions given for the organization. See OrganizationPermission.
roleIdstringyes The unique identifier of the role to update.
systemPermissions[SystemPermission]yes List of permissions given for users who are assigned the role. See SystemPermission.
viewPermissions[Permission]yes A list of permissions associated with the view. See Permission.

[a] Table last updated: Oct 4, 2024

[b] 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[a]

ParameterTypeRequired[b]DefaultDescription
roleRoleyes The role to update. See Role.

[a] Table last updated: Oct 4, 2024

[b] 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.