List members of an automation

This call returns a list of the members of the specified automation. For each member, the response lists the username and permissions for the specified automation.

Request

https://api.sbgenomics.com/v2/automation/automations/{automation-id}/members
https://eu-api.sbgenomics.com/v2/automation/automations/{automation-id}/members
https://gcp-api.sbgenomics.com/v2/automation/automations/{automation-id}/members

Example request

GET /v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d/members/ HTTP/1.1 Host: api.sbgenomics.com X-SBG-Auth-Token: 399a7a4df28b40bba1dc4e2cf6e59a6c
curl -s -H "X-SBG-Auth-Token: 399a7a4df28b40bba1dc4e2cf6e59a6c" -H "content-type: application/json" -X GET "https://api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d/members"
from sevenbridges import Api

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

automation = api.automations.get(id='40a284d9-c0da-441c-8799-3de8d85bbd8d')

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

for member in members:
    print(member.id, member.username, member.permissions)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-Type
required

application/json

X-SBG-Advance-Access
required

advance

Path parameters

Name

Description

automation_id
required

The ID of the automation for which you are listing members.

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/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d/members",
    "items": [
        {
            "href": "https://api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d/members/rfranklin",
            "username": "rfranklin",
            "permissions": {
                "write": true,
                "read": true,
                "copy": true,
                "execute": true,
                "admin": true
            }
        },
        {
            "href": "https://api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d/members/jsmith",
            "username": "jsmith",
            "permissions": {
                "write": true,
                "read": true,
                "copy": true,
                "execute": true,
                "admin": true
            }
        },
        {
            "href": "https://api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8d/members/rsmith",
            "username": "rsmith",
            "permissions": {
                "write": true,
                "read": true,
                "copy": true,
                "execute": true,
                "admin": false
            }
        }
    ],
    "links": []
}