The assignRoleToGroup() GraphQL mutation assigns a role to a group for a given view.

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

Syntax

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

graphql
assignRoleToGroup(
      input: AssignRoleToGroupInput!
   ): AssignRoleToGroupMutation!

Given Datatypes

For the input (i.e., AssignRoleToGroupInput), there are a few parameters that may be given. Below is a list of them along with their datatype and a description of each:

Table: AssignRoleToGroupInput

ParameterTypeRequired[a]DefaultDescription
viewIdstringyes Name of the view of the alert.
groupIdstringyes The unique identifier of the group being assigned.
roleIdstringyes The unique identifier of the role being assigned.

[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

As indicated by the syntax above, this mutation will return data using the input type, AssignRoleToGroupMutation. This datatype includes one parameters for values that may be returned:

Table: AssignRoleToGroupMutation

ParameterTypeRequired[a]DefaultDescription
groupSearchDomainRoleyes The group for which to add mutation (see SearchDomainRole 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.