Add a team to an automation (Enterprise)

If you are a member of an Enterprise and you have admin rights in an automation, you can add a team from your Division to that automation.

The permissions that you set will be applied to the whole team and you may assign the following permissions:

  • Read
  • Write
  • Copy
  • Execute
  • Admin

For more information, see the documentation on setting project member permissions. Note that some user permissions imply others: for example, if you give a user admin permission, then they automatically receive read, write, copy and execute permissions.

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

POST /v2/automation/automations/4b56738c-782c-571b-9832-1019398b7711/members HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: cb8e9582fdd94d6ba0ed1aba4eaf82a9
X-SBG-Advance-Access: advance
Content-Type: application/json
{
    "id" : "9356da15-bc09-478e-a399-8af9da5b64b7",
    "type" : "team",
    "permissions": {
        "read" : true,
        "copy" : true,
        "write": true,
        "execute": false,
        "admin": false
 
    }
}
curl -X POST \
  https://api.sbgenomics.com/v2/automation/automations/4b56738c-782c-481b-9832-1019398b7711/members \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: cb8e9582fdd94d6ba0ed2aba8eaf82a7' \
  -H 'cache-control: no-cache' \
  -d '{
    "id" : "9356da15-bb09-479e-a399-8af9da5b64b7",
    "type" : "team",
    "permissions": {
        "read" : true,
        "copy" : true,
        "write": true,
        "execute": false,
        "admin": false
 
    }
}'

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 you are adding the team to.

Request body

In the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table.

Name

Data type

Description

id
required

string

The id of the team you are adding to an automation.

type
required

string

Enter team.

permissions
required

boolean

The possible keys are:

"write" "read" "copy" "execute" "admin"

Each key may have the values true or false.

Example request body

{ 

     "id" : "924646fe-fe78-45b2-a20a-f473a8dcfe7b",
     "type": "team",
     "permissions": {
            "read" : true, 
            "copy" : true,
            "write": true, 
            "execute": false, 
            "admin": false
     }
}

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/{automation-id}/members/9356da15-bb09-479e-a399-8af9da5b64b7", 
     "username": "my team",
     "permissions": {
            "read" : true, 
            "copy" : true,
            "write": true, 
            "execute": false, 
            "admin": false
      }
}