GuidesAPIDatasets HubRelease Notes
API Reference
CGC

Get a project member's permissions

get https://cgc-api.sbgenomics.com/v2

/projects/{project_owner}/{project}/members/{username}

This returns the permissions of a specified user within a specified project.

Users may have the following permissions on the CGC:

  • Read
  • Write
  • Copy
  • Execute
  • Admin

Permissions are granted at the project-level. You may, for instance, have admin permission in one project, execute permission in another, and read-only permission in a third.

For more information on permissions on the CGC, see the documentation on setting permissions.

https://cgc-api.sbgenomics.com/v2/projects/{project_owner}/{project}/members/{username}

Request

Example request

GET /v2/projects/rfranklin/my-project/members/jane_doe HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/projects/RFranklin/my-project/members/Jane_Doe"

Header Fields

NameDescription
X-SBG-Auth-Token
required		Your CGC authentication token.

Path parameters

NameDescription
project_owner
required		The CGC username of the user who owns the project.
project
required		The short name of the project to access.
username
required		The CGC username of the user whose permissions you are enquiring about.

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.

Response

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

Example response body

{
    "href": "https://cgc-api.sbgenomics.com/v2/projects/RFranklin/my-project1/members/Jane_Doe",
    "username": "Jane_Doe",
    "permissions": {
        "write": true,
        "read": true,
        "copy": false,
        "execute": true,
        "admin": false
    }
}

📘

Project member permissions

Learn more about project member permissions.

Language