Platform documentationDatasetsAPIs
APIs
Log in to Seven Bridges Platform

Add a member to a project

post
https://api.sbgenomics.com/v2/projects///members

This call adds a new user to a specified project. It can only be successfully made by a user who has admin permissions in the project.

Users may have the following permissions on the Platform:

  • 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Path for Seven Bridges Platform EU

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/projects/{project_owner}/{project}/members

👍

Member permissions

Requests to add a project member must include the key permissions. However, if you do not include a value for some permission, it will be set to false by default. The exception to this rule is the read permission, which is the default permission on a project. It enables a user to read project data, including file names, but access file contents.

For more information, see the documentation on setting permissions.

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

Path Params
string
required

If you are using Enterprise, use the name of the Division that owns the project; otherwise, enter the project owner's Platform username.

string
required

The short name of the project you are adding someone to.

Query Params
fields
array of strings

Selector specifying a subset of fields to include in the response.

fields
Body Params
string

The Seven Bridges Platform username of the person you want to add to the project. You should use either username (recommended) or email.

string

The email address of the person you want to add to the project. This has to be the email address that the person used when registering for an account on the Seven Bridges Platform. You should use either username (recommended) or email.

permissions
object
required

Array of key-value pairs. The keys are strings, and the values are Booleans. All members of a project have read permissions by default. Even if you try setting the read permission to false, it will still default to true.

Headers
string
required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Response

Updated 8 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 months ago