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

For more information on user groups, see the Managing 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

ParameterTypeRequired[a]DefaultDescription
groupIdstringyes The unique identifier of the group to update.
displayNamestring  The display name for the group.
lookupNamestring  The lookup name for the group.

[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

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

ParameterTypeRequired[a]DefaultDescription
groupGroup  New group. (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.