List members of a volume

This call returns the members of a specific volume. The volume is specified as volume_id and consists of the owner and name of a volume (for example rfranklin/my-first-volume).

Request

https://api.sbgenomics.com/v2/storage/volumes/{volume_id}/members
https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_id}/members

Example request

GET /v2/storage/volumes/rfranklin/my-first-volume/members HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "Content-type: application/json" -X GET "https://api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/members"
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74')

volume = api.volumes.get(id='rfranklin/my-first-volume')

# send GET request to SB API
members = volume.get_members()

for member in members:
    print(member.username)

Header Fields

Key

Description of value

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-type
required

application/json

Path parameters

Key

Data type of value

Description of value

volume_id
required

String

The volume that you want to query, which consists of username of the volume owner and volume name, for example rfranklin/my-first-volume.

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Example response body

{
    "href": "https://api.sbgenomics.com/v2/storage/volumes/rfranklin/sb_qa_test_europe_west2/members?offset=0&limit=50",
    "items": [
        {
            "username": "rfranklin",
            "email": "[email protected]",
            "href": "https://api.sbgenomics.com/v2/storage/volumes/rfranklin/sb_qa_test_europe_west2/members/rfranklin",
            "permissions": {
                "write": true,
                "read": true,
                "copy": true,
                "admin": true
            },
            "type": "USER",
            "id": "rfranklin"
        }
    ],
    "links": []
}

Interpreting the response body

Volume members have the following permissions:

Key

Data type

Description

read

String

Set this to true to grant read permissions or false to remove them. read permissions allow a volume member to browse the contents of the volume.

copy

String

Set this to true to grant copy permissions or false to remove them. copy permissions allow a volume member to import the contents of the volume to the Platform.

write

String

Set this to true to grant write permissions or false to remove them. write permissions allow a volume member to export files from the Platform to the volume.

admin

String

Set this to true to grant admin permissions or false to remove them.