Group User & Manager

Use Cases

Add user to group

Adds one or more users to an existing group. The users are identified by their UUID. If a user is already a member of the group, they will be reported under alreadyAddedIds.

mutation {
  addUsersToGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1", "user-uuid-2"]
  ) {
    addedIds
    alreadyAddedIds
    failedIds
  }
}

Remove user from group

Removes users from a group. The server returns whether a user was actually removed or was no longer in the group.

mutation {
  removeUsersFromGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1"]
  ) {
    removedIds
    alreadyRemovedIds
    failedIds
  }
}

Add manager to group

Adds one or more users as managers to a group. This gives them administrative rights within that group.

mutation {
  addManagersToGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1"]
  ) {
    response {
      succeededIds
      failedIds
    }
  }
}

Remove manager from group

Removes one or more users as managers from a group. The users will no longer have administrative rights.

mutation {
  removeManagersFromGroup(
    groupId: "group-uuid"
    userIds: ["user-uuid-1"]
  ) {
    response {
      succeededIds
      failedIds
    }
  }
}

GraphQL Definitions

Mutations

The following mutations are available to add or remove users and managers from groups. Both groupId and groupRef can be used to identify the group. Similarly, users can be identified with userIds or userRefs.

addUsersToGroup(groupId: UUID, groupRef: String, userIds: [UUID!], userRefs: [String!]): AddUsersToGroup
removeUsersFromGroup(groupId: UUID, groupRef: String, userIds: [UUID!], userRefs: [String!]): RemoveUsersFromGroup
addManagersToGroup(groupId: UUID, groupRef: String, userIds: [UUID!], userRefs: [String!]): AddManagersToGroup
removeManagersFromGroup(groupId: UUID, groupRef: String, userIds: [UUID!], userRefs: [String!]): RemoveManagersFromGroup

Notes

• Both id and ref can be used for identification of groups and users.
• userIds is a list of UUIDs of users you want to add or remove.
• The response contains added, already added, and incorrectly processed IDs.
• Use addManagersToGroup/removeManagersFromGroup explicitly for manager roles.