addUsersToGroup( )

Attention

Under Development

Our GraphQL pages are currently under development. The content, links, tables, and structure of this material may change without notice.

The adduserstogroup GraphQL mutation field is used to adds users to an existing group.

For more information on user authorization, see the Authorization documentation page. In particular, read the section on groups, Groups.

Syntax

Below is the syntax for the adduserstogroup mutation field:

addUsersToGroup(input: AddUsersToGroupInput!clientMutationId: string): AddUsersToGroupMutation!
Given Datatypes

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

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

Table: clientMutationId

ParameterTypeRequired[a]DefaultDescription
clientMutationIdstring  datatype clientmutationid The client identifier for the mutation. This is deprecated: Humio will not continue supporting clientMutationId in results.

[a] Some arguments may be required, as indicated in this column. For some fields this column indicates that a result will always being returned for it.


Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, AddUsersToGroupMutation. Below is a list of the parameters of that datatype:

Table: AddUsersToGroupMutation

ParameterTypeRequired[a]DefaultDescription
clientMutationIdstringyes datatype adduserstogroupmutation The mutation identifier for the client. Deprecated: Humio will not continue supporting clientMutationId in results.
groupGroupyes 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 being returned for it.


The returned datatype has its own special datatypes. You can click on the links below for more information on its parameters:

  • Group

    Role

    Permission

    SystemPermission

    OrganizationPermission

    User