Skip to main content

AppGroupPolicy

Per-app, per-type policy controlling who may create groups of a type and the default membership policy of new groups.

type AppGroupPolicy {
  appId: BigInt!
  groupType: String!
  creationPolicy: String!
  defaultMembershipPolicy: String!
  maxMembers: Int
  maxGroupsPerUser: Int
}

Fields​

AppGroupPolicy.appId ● BigInt! non-null scalar​

The app (tenant) the policy applies to.

AppGroupPolicy.groupType ● String! non-null scalar​

The group type the policy governs: 'team' | 'channel' | 'grid'.

AppGroupPolicy.creationPolicy ● String! non-null scalar​

admin | member | anyone

AppGroupPolicy.defaultMembershipPolicy ● String! non-null scalar​

open | request | invite | admin

AppGroupPolicy.maxMembers ● Int scalar​

Optional cap on members per group (null = unlimited).

AppGroupPolicy.maxGroupsPerUser ● Int scalar​

Optional cap on groups of this type a user may belong to (null = unlimited).

Returned By​

channelPolicy query ● setChannelPolicy mutation ● setTeamPolicy mutation ● teamPolicy query