Skip to main content

Group Object

Represents permission group data.

type Group implements Node {
id: ID!
name: String!
users: [User!]
permissions: [Permission!]
userCanManage: Boolean!
accessibleChannels: [Channel!]
restrictedAccessToChannels: Boolean!
}

Fields

id ● ID!

The ID of the group.

name ● String!

The name of the group.

users ● [User!]

List of group users

Requires the MANAGE_STAFFpermission.

permissions ● [Permission!]

List of group permissions

userCanManage ● Boolean!

True, if the currently authenticated user has rights to manage a group.

accessibleChannels ● [Channel!]

List of channels the group has access to.

restrictedAccessToChannels ● Boolean!

Determine if the group have restricted access to channels.

Interfaces

Node

An object with an ID

Returned By

permissionGroup query

Member Of

GroupCountableEdge object ● PermissionGroupCreate object ● PermissionGroupCreated object ● PermissionGroupDelete object ● PermissionGroupDeleted object ● PermissionGroupUpdate object ● PermissionGroupUpdated object ● User object ● UserPermission object

Implemented By

_Entity union