User Groups API

Introduction

We usually interpret a user group as precisely what the name says: a group of users. For example, you may want to group users by their home country or any other characteristic. Read more about this topic in the user group feature guide.

Mutations

createUserGroup()

To create a user group, you simply need to define a name and reference. The API detail for the method can be find here (opens in a new tab).

await client.asSuperAdmin().createUserGroup(
  { userGroup: 
      { name: 'xyz789', reference: 'xyz789' }
  }
);

addUsersToUserGroup()

The addUsersToUserGroup() (opens in a new tab) API will add users to a user group, you can use this mutation with ROQ Node.js SDK or GraphQL:

await client.asSuperAdmin().addUsersToUserGroup(
  { userGroupId: "abc123", 
    userIds: ["abc123", '321cba'] 
  }
);

updateUserGroup()

The updateUserGroup() (opens in a new tab) API will update the user group data based on the user group id.

const updateGroup = await roqClient.asSuperAdmin().updateUserGroup({
  id: "42103455-1e00-41bf-9714-c70a8c17caf9",
  userGroup: {
    name: "Video Creator",
    reference: "video-creator-group"
  }
})

removeUsersFromUserGroup()

ROQ also provides an API to remove users from a user group. You can use the removeUsersFromUserGroup with Node.js SDK or GraphQL query. The API documentation is here (opens in a new tab).

const removeStatus = await roqClient.asSuperAdmin().removeUsersFromUserGroup({
  userGroupId: "554a2843-66dd-4c9a-adc1-0c48484591b6",
  userIds: ["244784e9-3b56-421c-925d-d9bbefab2de4"]
})
console.log(removeStatus)

{ removeUsersFromUserGroup: true }

Queries

userGroups()

With the userGroups() (opens in a new tab) API you can get all the registered user groups.

To see user groups with users you run a query like this:

await client.asSuperAdmin().userGroups({
  filter: {
    name: {
      like: "moderator"
    }
  }
  withUsers: true 
});

Another way to fetch users by a user group could look like:

await client.asSuperAdmin().users({ filter: { 
    userGroupId: {equalTo: "123" } 
    } 
});

userGroup()

The userGroup() (opens in a new tab) API is used to get the information about the specific user group.

const groupId = "42103455-1e00-41bf-9714-c70a8c17caf9";
const mygroup = await roqClient.asSuperAdmin().userGroup(groupId);