GroupRole

A role within a group (team/channel). Carries the group-management permission keys it grants (e.g. manage_members), NOT world/runtime grid permissions.

type GroupRole {
  groupRoleId: BigInt!
  groupId: BigInt!
  roleName: String!
  rank: Int!
  isSystem: Boolean!
  permissions: [String!]!
  createdAt: DateTime!
}

Fields

GroupRole.groupRoleId ● BigInt! non-null scalar

Unique role id.

GroupRole.groupId ● BigInt! non-null scalar

The group this role belongs to.

GroupRole.roleName ● String! non-null scalar

Role display name (unique within the group).

GroupRole.rank ● Int! non-null scalar

Sort/precedence rank; higher is more senior.

GroupRole.isSystem ● Boolean! non-null scalar

True for built-in roles (e.g. 'leader') that cannot be renamed, re-ranked, or deleted.

GroupRole.permissions ● [String!]! non-null scalar

Group permission key strings this role grants (e.g. manage_members, manage_roles, manage_group, send_messages).

GroupRole.createdAt ● DateTime! non-null scalar

When the role was created.

Returned By

channelRoles query ● createChannelRole mutation ● createTeamRole mutation ● teamRoles query ● updateChannelRole mutation ● updateTeamRole mutation

Member Of

GroupMember object ● GroupMembership object