title: GroupPermission
type: object
description: A permission that can be granted to a role in a group.
properties:
  allowedToAdd:
    type: boolean
    description: Whether the user is allowed to add this permission to a role.
    default: false
    examples:
      - true
  dependsOn:
    type: array
    description: Other permission names this one is listed against.
    items:
      $ref: ./GroupPermissions.yaml
  displayName:
    type: string
    description: The display name of the permission.
    examples:
      - Manage Group Data
  help:
    type: string
    description: Human-readable description of the permission.
    examples:
      - Allows role to edit group details (name, description, joinState, initialRoles, etc).
  isManagementPermission:
    type: boolean
    description: Whether this permission is a "management" permission.
    default: false
    examples:
      - true
  name:
    type: string
    description: The name of the permission.
    examples:
      - group-data-manage