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

Group.id ● ID! non-null scalar miscellaneous

The ID of the group.

Group.name ● String! non-null scalar miscellaneous

The name of the group.

Group.users ● [User!] list object users

List of group users

Requires MANAGE_STAFFpermission.

Group.permissions ● [Permission!] list object authentication

List of group permissions

Group.userCanManage ● Boolean! non-null scalar miscellaneous

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

Group.accessibleChannels ● [Channel!] list object channels

List of channels the group has access to.

Group.restrictedAccessToChannels ● Boolean! non-null scalar miscellaneous

Determine if the group have restricted access to channels.

Interfaces

Node interface miscellaneous

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