The assignOrganizationRoleToGroup() GraphQL mutation field is used to assign an organization role to a group. This field is not yet available. It's described here as a preview.

This is an experimental feature, not ready for production.

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

graphql
assignOrganizationRoleToGroup(
       input: AssignOrganizationRoleToGroupInput!
    ): AssignOrganizationRoleToGroupMutation!

Given Datatypes

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

Table: AssignOrganizationRoleToGroupInput

ParameterTypeRequired[a]DefaultDescription
groupId[string]yes The unique identifier of the group.
roleIdstring  The unique identifier of the role.

[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, AssignOrganizationRoleToGroupMutation. Below is the parameter of that datatype:

Table: AssignOrganizationRoleToGroupMutation

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