The updateGroup() GraphQL mutation may be used to update a given group in LogScale.

For more information on user groups, see the Manage Groups documentation page.

Syntax

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

graphql
updateGroup(
      input: UpdateGroupInput!
   ): UpdateGroupMutation!

Given Datatypes

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

Table: UpdateGroupInput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
displayNamestring  The display name for the group.
groupIdstringyes The unique identifier of the group to update.
lookupNamestring  The lookup name for the group.

Returned Datatypes

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

Table: UpdateGroupMutation

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 4, 2024
groupGroup  The group to update. See Group.