groups

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/groups

Object type: j7d0g

Example UUID: zzzzz-j7d0g-0123456789abcde

Resource

Groups provides a way to apply the same permissions to a set of Arvados objects. See permission model for details.

Each Group has, in addition to the Common resource fields:

Attribute	Type	Description	Example
name	string
group_class	string	Type of group. project and filter indicate that the group should be displayed by Workbench and arv-mount as a project for organizing and naming objects. role is used as part of the permission system.	"filter" "project" "role"
description	text
properties	hash	User-defined metadata, may be used in queries using subproperty filters
writable_by	array	(Deprecated) List of UUID strings identifying Users and other Groups that have write permission for this Group. Users who are allowed to administer the Group will receive a list of user/group UUIDs that have permission via explicit permission links; permissions via parent/ancestor groups are not taken into account. Other users will receive a partial list including only the Group’s owner_uuid and (if applicable) their own user UUID.
can_write	boolean	True if the current user has write permission on this group.
can_manage	boolean	True if the current user has manage permission on this group.
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.
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.
is_trashed	datetime	True if trash_at is in the past, false if not.
frozen_by_uuid	string	For a frozen project, indicates the user who froze the project; null in all other cases. When a project is frozen, no further changes can be made to the project or its contents, even by admins. Attempting to add new items or modify, rename, move, trash, or delete the project or its contents, including any subprojects, will return an error.

Frozen projects

A user with manage permission can set the frozen_by_uuid attribute of a project group to their own user UUID. Once this is done, no further changes can be made to the project or its contents, including subprojects.

The frozen_by_uuid attribute can be cleared by an admin user. It can also be cleared by a user with manage permission, unless the API.UnfreezeProjectRequiresAdmin configuration setting is active.

The optional API.FreezeProjectRequiresDescription and API.FreezeProjectRequiresProperties configuration settings can be used to prevent users from freezing projects that have empty description and/or specified properties entries.

Filter groups

filter groups are virtual groups; they can not own other objects. Filter groups have a special properties field named filters, which must be an array of filter conditions. See list method filters for details on the syntax of valid filters, but keep in mind that the attributes must include the object type (collections, container_requests, groups, workflows), separated with a dot from the field to be filtered on.

Filters are applied with an implied and between them, but each filter only applies to the object type specified. The results are subject to the usual access controls – they are a subset of all objects the user can see. Here is an example:

 "properties":{
  "filters":[
   [
    "groups.name",
    "like",
    "Public%"
   ]
  ]
 },

This filter group will return all groups (projects) that have a name starting with the word Public and are visible to the user issuing the query. Because groups can contain many types of object, it will also return all objects of other types that the user can see.

The ‘is_a’ filter operator is of particular interest to limit the filter group ‘content’ to the desired object(s). When the ‘is_a’ operator is used, the attribute must be ‘uuid’. The operand may be a string or an array which means objects of either type will match the filter. This example will return all groups (projects) that have a name starting with the word Public, as well as all collections that are in the project with uuid zzzzz-j7d0g-0123456789abcde.

 "properties":{
  "filters":[
   [
    "groups.name",
    "like",
    "Public%"
   ],
   [
    "collections.owner_uuid",
    "=",
    "zzzzz-j7d0g-0123456789abcde"
   ],
   [
    "uuid",
    "is_a",
    [
     "arvados#group",
     "arvados#collection"
    ]
   ]
  ]
 },
 

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

contents

Retrieve a list of items owned by the group. Use “recursive” to list objects within subprojects as well.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the group in question.	path
limit	integer (default 100)	Maximum number of items to return.	query
order	array	Attributes to use as sort keys to determine the order resources are returned, each optionally followed by asc or desc to indicate ascending or descending order. Sort within a resource type by prefixing the attribute with the resource name and a period.	query	["collections.modified_at desc"]
filters	array	Conditions for filtering items.	query	[["uuid", "is_a", "arvados#job"]]
recursive	boolean (default false)	Include items owned by subprojects.	query	true
exclude_home_project	boolean (default false)	Only return items which are visible to the user but not accessible within the user’s home project. Use this to get a list of items that are shared with the user. Uses the logic described under the “shared” endpoint.	query	true
include	string	If provided with the value “owner_uuid”, this will return owner objects in the “included” field of the response.	query
include_trash	boolean (default false)	Include trashed objects.	query	true
include_old_versions	boolean (default false)	Include past versions of the collections being listed.	query	true

Notes:

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 with the filter ["owner_uuid", "=", GROUP_UUID], and "manifest_text" listed in the select parameter.

Use filters with the attribute format <item type>.<field name> to filter items of a specific type. For example: ["container_requests.state", "=", "Final"] to filter container_requests where state is Final. All other types of items owned by this group will be unimpacted by this filter and will still be included.

When called with “include=owner_uuid”, the included field of the response is populated with users, projects, or other groups that own the objects returned in items. This can be used to fetch an object and its parent with a single API call.

create

Create a new Group.

Arguments:

Argument	Type	Description	Location	Example
group	object		query
async	boolean (default false)	Defer the permissions graph update by a configured number of seconds. (By default, async_permissions_update_interval is 20 seconds). On success, the response is 202 (Accepted).	query	true

delete

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.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Group in question.	path

get

Gets a Group’s metadata by UUID.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Group in question.	path

list

List groups.

See common resource list method.

show

show groups

Arguments:

Argument	Type	Description	Location	Example
uuid	string		path

update

Update attributes of an existing Group.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Group in question.	path
group	object		query
async	boolean (default false)	Defer the permissions graph update by a configured number of seconds. (By default, async_permissions_update_interval is 20 seconds). On success, the response is 202 (Accepted).	query	true

untrash

Remove a Group from the trash. This sets the trash_at and delete_at fields to null.

Arguments:

Argument	Type	Description	Location	Example
uuid	string	The UUID of the Group to untrash.	path
ensure_unique_name	boolean (default false)	Rename project uniquely if untrashing it would fail with a unique name conflict.	query

shared

This endpoint returns the toplevel set of groups to which access is granted through a chain of one or more permission links rather than through direct ownership by the current user account. This is useful for clients which wish to browse the list of projects the user has permission to read which are not part of the “home” project tree. Similar behavior is also available with the exclude_home_project option of the “contents” endpoint.

Specifically, the logic is:

select groups that are readable by current user AND
    (the owner_uuid is a user (but not the current user) OR
     the owner_uuid is not readable by the current user OR
     the owner_uuid is a group but group_class is not a project)

Argument	Type	Description	Location	Example
include	string	If provided with the value “owner_uuid”, this will return owner objects in the included field of the response.	query

Notes:

When called with “include=owner_uuid”, the included field of the response is populated with users and non-project groups that own the objects returned in items.

In addition to the “include” parameter this endpoint also supports the same parameters as the list method.

---

Previous: authorized_keys Next: users