8 Copyright (C) The Arvados Authors. All rights reserved.
10 SPDX-License-Identifier: CC-BY-SA-3.0
13 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/groups@
17 Example UUID: @zzzzz-j7d0g-0123456789abcde@
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.
23 Each Group has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
25 table(table table-bordered table-condensed).
26 |_. Attribute|_. Type|_. Description|_. Example|
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"@
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.||
35 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
37 Required arguments are displayed in %{background:#ccffcc}green%.
41 Retrieve a list of items owned by the group.
45 table(table table-bordered table-condensed).
46 |_. Argument |_. Type |_. Description |_. Location |_. Example |
47 {background:#ccffcc}.|uuid|string|The UUID of the group in question.|path||
48 |limit|integer (default 100)|Maximum number of items to return.|query||
49 |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"@|
50 |filters|array|Conditions for filtering items.|query|@[["uuid", "is_a", "arvados#job"]]@|
51 |recursive|boolean (default false)|Include items owned by subprojects.|query|@true@|
53 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.
55 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.
63 table(table table-bordered table-condensed).
64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
65 |group|object||query||
69 Delete an existing Group.
73 table(table table-bordered table-condensed).
74 |_. Argument |_. Type |_. Description |_. Location |_. Example |
75 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
79 Gets a Group's metadata by UUID.
83 table(table table-bordered table-condensed).
84 |_. Argument |_. Type |_. Description |_. Location |_. Example |
85 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
91 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
99 table(table table-bordered table-condensed).
100 |_. Argument |_. Type |_. Description |_. Location |_. Example |
101 {background:#ccffcc}.|uuid|string||path||
105 Update attributes of an existing Group.
109 table(table table-bordered table-condensed).
110 |_. Argument |_. Type |_. Description |_. Location |_. Example |
111 {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path||
112 |group|object||query||