doc/api/schema/Group.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: Group
   6
   7 ...
   8
   9 A **Group** represents a set of objects. Groups allow you to organize content, define user roles, and apply permissions to sets of objects.
  10
  11 h2. Methods
  12
  13 See "groups":{{site.baseurl}}/api/methods/groups.html
  14
  15 h2. Resource
  16
  17 Each Group has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  18
  19 table(table table-bordered table-condensed).
  20 |_. Attribute|_. Type|_. Description|_. Example|
  21 |name|string|||
  22 |group_class|string|Type of group. This does not affect behavior, but determines how the group is presented in the user interface. For example, @project@ indicates that the group should be displayed by Workbench and arv-mount as a project for organizing and naming objects.|@"project"@
  23 null|
  24 |description|text|||
  25 |writable_by|array|List of UUID strings identifying Users and other Groups that have write permission for this Group.  Only users who are allowed to administer the Group will receive a full list.  Other users will receive a partial list that includes the Group's owner_uuid and (if applicable) their own user UUID.||