Skip to main content
Version: Canary ๐Ÿšง

Group

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โ€‹

The ID of the group.

Group.nameย โ—ย String! non-null scalarโ€‹

The name of the group.

Group.usersย โ—ย [User!] list objectโ€‹

List of group users

Requires MANAGE_STAFFpermission.

Group.permissionsย โ—ย [Permission!] list objectโ€‹

List of group permissions

Group.userCanManageย โ—ย Boolean! non-null scalarโ€‹

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

Group.accessibleChannelsย โ—ย [Channel!] list objectโ€‹

List of channels the group has access to.

Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

Group.restrictedAccessToChannelsย โ—ย Boolean! non-null scalarโ€‹

Determine if the group have restricted access to channels.

Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

Interfacesโ€‹

Node interfaceโ€‹

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


Was this page helpful?