For
...
Users
When you are logging in, your Synapse credentials can be stored using the rememberMe parameter. You should use the rememberMe feature only if you are on a personal computer where you are the only Synapse user. Visit the Python synapseclient docs and R synapser docs for Python client docs and R client docs for examples.
For
...
Developers
Customize the Synapse
...
Configuration File
Synapse configuration parameters for frequently used client-interactions can be set in a specific configuration file. By default, the file is in the user’s home directory and is called .synapseConfig. For example, you can set:
a A new cache location
Third party credentials to access files stored outside of Synapse (e.g. AWS-S3, etc.)
an API key to authenticate loginYour Synapse credentials, preferably in the form of an access token
Note the period at the beginning of the file name that makes it a hidden system file on Linux-like operating systems, since it will contain sensitive information.
When you install the Synapse Python client, a .synapseConfig file filled with examples should appear in your home directory if a configuration file is not already present. You can uncomment and fill out the parameters of interest.
You may also customize a .synapseConfig file when you install the Synapse R client.
Where to find your API key
From your Synapse homepage, navigate to your user profile icon in the upper right corner and select Settings from the drop-down menu. Your Synapse API key is made visible by selecting Show API Key. If the confidentiality of your API key is compromised, or you would like to invalidate your API key, select Change API Key.
See also:
/wiki/spaces/DOCS/pages/1985249668, /wiki/spaces/DOCS/pages/2048327803, Downloading data
Include Page
.synapseConfig template can also be obtained here.See the following for more information on managing credentials in the .synapseConfig