X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a2107d5fc7982769c2d667e51656a6e2529d9bc9..ff8721dd5854279fab712f4a4ff8aed2256c1b87:/doc/api/schema/Group.html.textile.liquid diff --git a/doc/api/schema/Group.html.textile.liquid b/doc/api/schema/Group.html.textile.liquid index 7fe3f11c26..2bf67eb6ff 100644 --- a/doc/api/schema/Group.html.textile.liquid +++ b/doc/api/schema/Group.html.textile.liquid @@ -6,32 +6,20 @@ title: Group ... -h1. Group - -A **Group** represents... +A **Group** represents a set of objects. Groups allow you to organize content, define user roles, and apply permissions to sets of objects. h2. Methods -See "REST methods for working with Arvados resources":/api/methods.html - -API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@ - -h2. Creation - -h3. Prerequisites - -Prerequisites for creating a Group. - -h3. Side effects - -Side effects of creating a Group. +See "groups":{{site.baseurl}}/api/methods/groups.html -h2. Resources +h2. Resource -Each Group has, in addition to the usual "attributes of Arvados resources":/api/resources.html: +Each Group has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| |name|string||| +|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"@ +null| |description|text||| -|updated_at|datetime||| +|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.||