{"_id":"5b0e13ffc4664e0003c75c3e","user":"554340dfb7f4540d00fcef1d","project":"5b0e13ffc4664e0003c75a66","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"__v":0,"parentDoc":null,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":["56a5f4ecd222d20d00500daf"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T19:38:31.009Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":4,"body":"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](doc:get-my-information). \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/users/{username}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\nThis call will only return a successful response if `{username}` is replaced with your own username.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Case sensitivity\",\n  \"body\": \"Don't forget to capitalize your `username` in the same way as you set it when you registered on the DataSTAGE powered by Seven Bridges.\"\n}\n[/block]\n \n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/users/RFranklin HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://f4c-api.sbgenomics.com/v2/users/RFranklin\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your Platform [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`username`\",\n    \"0-1\": \"Username of the user you're querying.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"**fields**\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes)\n\n###Example response body \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/users/RFranklin\\\",\\n  \\\"username\\\": \\\"RFranklin\\\",\\n  \\\"email\\\": \\\"rosalind.franklin:::at:::sbgenomics.com\\\",\\n  \\\"first_name\\\": \\\"Rosalind\\\",\\n  \\\"last_name\\\": \\\"Franklin\\\",\\n  \\\"affiliation\\\": \\\"Seven Bridges\\\",\\n  \\\"phone\\\": \\\"\\\",\\n  \\\"address\\\": \\\"\\\",\\n  \\\"city\\\": \\\"London\\\",\\n  \\\"state\\\": \\\"\\\",\\n  \\\"country\\\": \\\"United Kingdom\\\",\\n  \\\"zip_code\\\": \\\"\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/users/{username}","slug":"list-user-resources","type":"endpoint","title":"List user resources"}

getList user resources

/users/{username}

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](doc:get-my-information). [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/users/{username}", "language": "text", "name": "Path" } ] } [/block] This call will only return a successful response if `{username}` is replaced with your own username. [block:callout] { "type": "success", "title": "Case sensitivity", "body": "Don't forget to capitalize your `username` in the same way as you set it when you registered on the DataSTAGE powered by Seven Bridges." } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/users/RFranklin HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://f4c-api.sbgenomics.com/v2/users/RFranklin\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your Platform [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`username`", "0-1": "Username of the user you're querying." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "**fields**", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/users/RFranklin\",\n \"username\": \"RFranklin\",\n \"email\": \"rosalind.franklin@sbgenomics.com\",\n \"first_name\": \"Rosalind\",\n \"last_name\": \"Franklin\",\n \"affiliation\": \"Seven Bridges\",\n \"phone\": \"\",\n \"address\": \"\",\n \"city\": \"London\",\n \"state\": \"\",\n \"country\": \"United Kingdom\",\n \"zip_code\": \"\"\n}", "language": "json" } ], "sidebar": true } [/block]