groups

API endpoint base: https://qr1hi.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. 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
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.

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.

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 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"
filters array Conditions for filtering items. query [["uuid", "is_a", "arvados#job"]]

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

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.

create

Create a new Group.

Arguments:

Argument Type Description Location Example
group object query

delete

Delete an existing Group.

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

Previous: authorized_keys Next: users

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.