List user resources

This call returns information about the specified user. Note that currently you can view only your own user information, and so this call is equivalent to the call to Get my information.

Request

https://api.sbgenomics.com/v2/users/{username}
https://eu-api.sbgenomics.com/v2/users/{username}

This call will only return a successful response if {username} is replaced with your own username.

👍

Case sensitivity

Don't forget to capitalize your username in the same way as you set it when you registered on the Seven Bridges Platform.

Example Request

GET /v2/users/RFranklin HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sbgenomics.com/v2/users/RFranklin"
from sevenbridges import Api

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

# send GET request to SB API
user = api.users.get(user='RFranklin')

print(user.first_name, user.last_name, user.email)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Path parameters

Name

Description

username

Username of the user you are querying.

Query parameters

Name

Data type

Description

fields

string

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

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/users/RFranklin",
  "username": "RFranklin",
  "email": "[email protected]",
  "first_name": "Rosalind",
  "last_name": "Franklin",
  "affiliation": "Seven Bridges",
  "phone": "",
  "address": "",
  "city": "London",
  "state": "",
  "country": "United Kingdom",
  "zip_code": ""
}