Get a project member's permissions

/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 Platform:

• 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 Platform, see the documentation on setting permissions.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/{project_owner}/{project}/members/{username}

Request

Example request

HTTP

GET /v2/projects/rfranklin/my-project/members/jane_doe HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklin/my-project/members/Jane_Doe"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your Platform authentication token.

Path parameters

Name	Description
project_owner required	The Platform username of the user who owns the project.
project required	The short name of the project to access.
username required	The Plartform username of the user whose permissions you are enquiring about.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.

Response

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

Example response body

JSON

{
    "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklin/my-project1/members/John_Smith",
    "username": "John_Smith",
    "permissions": {
        "write": true,
        "read": true,
        "copy": false,
        "execute": true,
        "admin": false
    }
}

📘

Project member permissions

Learn more about project member permissions.