There are multiple ways one can login to Synapse. We recommend users to choose the method that fits their workflow.

One Time Login

Use a personal access token token obtained from under your Settings. Note that a token must minimally have the view scope to be used with the Synapse Python Client.

syn = synapseclient.login(authToken="authtoken")

Use Environment Variable

Setting the SYNAPSE_AUTH_TOKEN environment variable will allow you to login to Synapse with a personal access token

The environment variable will take priority over credentials in the user’s .synapseConfig file.

In your shell, you can pass an environment variable to Python inline by defining it before the command:

SYNAPSE_AUTH_TOKEN='<my_personal_access_token>' python3

Alternatively you may export it first, then start: Python

export SYNAPSE_AUTH_TOKEN='<my_personal_access_token>'

Once you are inside Python, you may simply login without passing any arguments:

import synapseclient
syn = synapseclient.login()

To use the environment variable with the command line client, simply substitute python for the synapse command

SYNAPSE_AUTH_TOKEN='<my_personal_access_token>' synapse get syn123
SYNAPSE_AUTH_TOKEN='<my_personal_access_token>' synapse store --parentid syn123 ~/foobar.txt

Or alternatively, for multiple commands:

export SYNAPSE_AUTH_TOKEN='<my_personal_access_token>'
synapse get syn123
synapse store --parentid syn123 ~/foobar.txt

Use .synapseConfig

For writing code using the Synapse Python client that is easy to share with others, please do not include your credentials in the code. Instead, please use .synapseConfig file to manage your credentials.

When installing the Synapse Python client, the .synapseConfig is added to your home directory.

You may also create the ~/.synapseConfig file by utilizing the command line client command and following the interactive prompts:

synapse config

The following describes how to add your credentials to the .synapseConfig file without the use of the synapse config command.

Open the .synapseConfig file and find the following section:

#username = <username>
#authtoken = <authtoken>

To enable this section, uncomment it. You don’t need to specify your username when using authtoken as a pair, but if you do, it will be used to verify your identity. A personal access token generated from your Settings can be used as your .synapseConfig authtoken.

authtoken = <authtoken>

Now, you can login without specifying any arguments:

import synapseclient
syn = synapseclient.login()

For legacy compatibility, the .synapseConfig [authentication] section will continue to support apikey or username + password pair until early 2024 when they are both deprecated in favor of personal access tokens (authtoken) which can be scoped to certain functions and are revocable.

For more information, see: