The assignSystemRoleToGroup() GraphQL mutation may be used to assign a system role to a group.

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

graphql
assignSystemRoleToGroup(
      input: AssignSystemRoleToGroupInput!
   ): AssignSystemRoleToGroupMutation!

Given Datatypes

For the input (i.e., AssignSystemRoleToGroupInput), 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: AssignSystemRoleToGroupInput

ParameterTypeRequired[a]DefaultDescription
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 datatype, AssignSystemRoleToGroupMutation. Below is a list of the parameters of that datatype:

Table: AssignSystemRoleToGroupMutation

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