{"_id":"5a2a845688574d001e993518","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5a2a81f688574d001e9934f5","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-12-08T12:13:42.092Z","from_sync":false,"order":36,"slug":"sbfs-command-reference","title":"SBFS Command Reference"},"user":"566590c83889610d0008a253","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-08T12:23:50.790Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"##Overview\n\nConfigure credentials for accessing your project on CGC.\n\nTo access a project on CGC, you have to provide the API endpoint and your authentication token. This can be done either via the unified configuration file(recommended), the environment variables or by specifying them as command options.\n\nLearn more about [storing, managing and using credentials](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries).\n\nThe optional use of the profile global parameter allows you to configure a profile which can be used with the list or mount commands. Learn more about profiles.\n\nThe optional use of the `profile` global parameter allows you to configure a profile which can be used with the `list` or `mount` commands. [Learn more](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries#section-unified-configuration-file) about profiles.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sbfs configure [parameters]\\n \\nParameters\\n  -h, --help   help for configure\",\n      \"language\": \"text\",\n      \"name\": \"Configure\"\n    }\n  ]\n}\n[/block]\n##Examples\n\n###Initial default setup\n\nThe credentials file will be created in `$HOME/.sevenbridges/credentials` with the default profile for which you need to provide the required parameters.  \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ sbfs configure\\nAPI endpoint [None]: https://cgc-api.sbgenomics.com/v2\\nAuthentication token [None]: 2cba934exAMPle09bf1700cd8EXampLE\",\n      \"language\": \"text\",\n      \"name\": \"Initial default setup\"\n    }\n  ]\n}\n[/block]\n###Create and configure a new profile \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ sbfs --profile \\\"my-other-account\\\" configure\\nAPI endpoint [None]: https://cgc-api.sbgenomics.com/v2\\nAuthentication token [None]: 90d7017exAMPle48934a5c750EXampLE\",\n      \"language\": \"text\",\n      \"name\": \"Create and configure a new profile\"\n    }\n  ]\n}\n[/block]\n###Modify a profile\nExisting values for the API endpoint and authentication token are displayed in the brackets, pressing Enter leaves current value unchanged.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ sbfs --profile \\\"my-other-account\\\" configure\\nAPI endpoint [https://cgc-api.sbgenomics.com/v2]: <Enter>\\nAuthentication token [***************hjkl]: d7017exAMPle48934a5c750EXampLE09\",\n      \"language\": \"text\",\n      \"name\": \"Modify a profile\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"configure","type":"basic","title":"Configure"}
##Overview Configure credentials for accessing your project on CGC. To access a project on CGC, you have to provide the API endpoint and your authentication token. This can be done either via the unified configuration file(recommended), the environment variables or by specifying them as command options. Learn more about [storing, managing and using credentials](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries). The optional use of the profile global parameter allows you to configure a profile which can be used with the list or mount commands. Learn more about profiles. The optional use of the `profile` global parameter allows you to configure a profile which can be used with the `list` or `mount` commands. [Learn more](doc:store-credentials-to-access-seven-bridges-client-applications-and-libraries#section-unified-configuration-file) about profiles. [block:code] { "codes": [ { "code": "Usage:\n sbfs configure [parameters]\n \nParameters\n -h, --help help for configure", "language": "text", "name": "Configure" } ] } [/block] ##Examples ###Initial default setup The credentials file will be created in `$HOME/.sevenbridges/credentials` with the default profile for which you need to provide the required parameters. [block:code] { "codes": [ { "code": "$ sbfs configure\nAPI endpoint [None]: https://cgc-api.sbgenomics.com/v2\nAuthentication token [None]: 2cba934exAMPle09bf1700cd8EXampLE", "language": "text", "name": "Initial default setup" } ] } [/block] ###Create and configure a new profile [block:code] { "codes": [ { "code": "$ sbfs --profile \"my-other-account\" configure\nAPI endpoint [None]: https://cgc-api.sbgenomics.com/v2\nAuthentication token [None]: 90d7017exAMPle48934a5c750EXampLE", "language": "text", "name": "Create and configure a new profile" } ] } [/block] ###Modify a profile Existing values for the API endpoint and authentication token are displayed in the brackets, pressing Enter leaves current value unchanged. [block:code] { "codes": [ { "code": "$ sbfs --profile \"my-other-account\" configure\nAPI endpoint [https://cgc-api.sbgenomics.com/v2]: <Enter>\nAuthentication token [***************hjkl]: d7017exAMPle48934a5c750EXampLE09", "language": "text", "name": "Modify a profile" } ] } [/block]