The removeUsersFromGroup() GraphQL mutation is used to removes users from a group in LogScale.

For more information on user authorization, see the Managing Users & Permissions documentation page. In particular, read the section on groups, Managing Groups.

Syntax

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

graphql
removeUsersFromGroup(
      input: RemoveUsersFromGroupInput!
   ): RemoveUsersFromGroupMutation!

Given Datatypes

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

Table: RemoveUsersFromGroupInput

ParameterTypeRequired[a]DefaultDescription
users[string]yes List of users to remove from the group.
groupIdstringyes The unique identifier of the group from which users should be removed.

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

Table: RemoveUsersFromGroupMutation

ParameterTypeRequired[a]DefaultDescription
groupGroupyes The group from which to remove users from 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.