The removeGroup() GraphQL mutation may be used to removes a group from LogScale. Only usable if roles are not managed externally (e.g., in LDAP).

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

Syntax

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

graphql
removeGroup(
      groupId: string!
   ): RemoveGroupMutation!

Given Datatypes

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

Table: BooleanResultType

ParameterTypeRequired[a]DefaultDescription
resultsbooleanyes Whether the mutation was performed or not.

[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 RemoveGroupMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: RemoveGroupMutation

ParameterTypeRequired[a]DefaultDescription
groupGroupyes The group associated with the 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.