doc/api/methods/groups.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "groups"
   6 ...
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@
  14
  15 Object type: @j7d0g@
  16
  17 Example UUID: @zzzzz-j7d0g-0123456789abcde@
  18
  19 h2. Resource
  20
  21 Groups provides a way to apply the same permissions to a set of Arvados objects.  See "permission model":{{site.baseurl}}/api/permission-model.html for details.
  22
  23 Each Group has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  24
  25 table(table table-bordered table-condensed).
  26 |_. Attribute|_. Type|_. Description|_. Example|
  27 |name|string|||
  28 |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"@
  29 null|
  30 |description|text|||
  31 |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.||
  32 |trash_at|datetime|If @trash_at@ is non-null and in the past, this group and all objects directly or indirectly owned by the group will be hidden from API calls.  May be untrashed.||
  33 |delete_at|datetime|If @delete_at@ is non-null and in the past, the group and all objects directly or indirectly owned by the group may be permanently deleted.||
  34 |is_trashed|datetime|True if @trash_at@ is in the past, false if not.||
  35
  36 h2. Methods
  37
  38 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  39
  40 Required arguments are displayed in %{background:#ccffcc}green%.
  41
  42 h3. contents
  43
  44 Retrieve a list of items owned by the group.
  45
  46 Arguments:
  47
  48 table(table table-bordered table-condensed).
  49 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  50 {background:#ccffcc}.|uuid|string|The UUID of the group in question.|path||
  51 |limit|integer (default 100)|Maximum number of items to return.|query||
  52 |order|string|Order in which to return matching items.  Sort within a resource type by prefixing the attribute with the resource name and a dot.|query|@"collections.modified_at desc"@|
  53 |filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@|
  54 |recursive|boolean (default false)|Include items owned by subprojects.|query|@true@|
  55
  56 Note: Because adding access tokens to manifests can be computationally expensive, the @manifest_text@ field is not included in listed collections.  If you need it, request a "list of collections":{{site.baseurl}}/api/methods/collections.html with the filter @["owner_uuid", "=", GROUP_UUID]@, and @"manifest_text"@ listed in the select parameter.
  57
  58 Note: Use filters with the attribute format @<item type>.<field name>@ to filter items of a specific type. For example: @["pipeline_instances.state", "=", "Complete"]@ to filter @pipeline_instances@ where @state@ is @Complete@. All other types of items owned by this group will be unimpacted by this filter and will still be included.
  59
  60 h3. create
  61
  62 Create a new Group.
  63
  64 Arguments:
  65
  66 table(table table-bordered table-condensed).
  67 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  68 |group|object||query||
  69
  70 h3. delete
  71
  72 Put a Group in the trash.  This sets the @trash_at@ field to @now@ and @delete_at@ field to @now@ + token TTL.  A trashed group is invisible to most API calls unless the @include_trash@ parameter is true.  All objects directly or indirectly owned by the Group are considered trashed as well.
  73
  74 Arguments:
  75
  76 table(table table-bordered table-condensed).
  77 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  78 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  79
  80 h3. get
  81
  82 Gets a Group's metadata by UUID.
  83
  84 Arguments:
  85
  86 table(table table-bordered table-condensed).
  87 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  88 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
  89
  90 h3. list
  91
  92 List groups.
  93
  94 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  95
  96 h3. show
  97
  98 show groups
  99
 100 Arguments:
 101
 102 table(table table-bordered table-condensed).
 103 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 104 {background:#ccffcc}.|uuid|string||path||
 105
 106 h3. update
 107
 108 Update attributes of an existing Group.
 109
 110 Arguments:
 111
 112 table(table table-bordered table-condensed).
 113 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 114 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
 115 |group|object||query||
 116
 117 h3. untrash
 118
 119 Remove a Group from the trash.  This sets the @trash_at@ and @delete_at@ fields to @null@.
 120
 121 Arguments:
 122
 123 table(table table-bordered table-condensed).
 124 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 125 {background:#ccffcc}.|uuid|string|The UUID of the Group to untrash.|path||
 126 |ensure_unique_name|boolean (default false)|Rename project uniquely if untrashing it would fail with a unique name conflict.|query||