Command line client does not support apikey


apikey is not a valid argument for the command line client: synapse login

Users that sign up to Synapse using OAuth will not have a password to enter here.

This is is a critical fix since portals currently only surface programmatic download instructions for the command line client.




Kelsey Montgomery
August 31, 2020, 4:18 PM

Tested release candidate for version 2.2.0 and am able to pass the apikey as a password to authenticate.

Kelsey Montgomery
August 20, 2020, 7:02 PM

code looks good!

Jordan Kiang
August 20, 2020, 12:30 AM

This is resolved and will be included in the next RC. In the command line client you can use the api key as you would the password.

Kelsey Montgomery
August 18, 2020, 8:10 PM

I do not have a specific instance where a user has been blocked from using the CLI because they created a Synapse account via Google but I expect this issue to present itself in the near future as the OAuth has been released for several months at this point.

Yes Jordan, this is critical because we are publishing portal documentation (in print, that cannot be revised at a later date) with step-by-step instructions of downloading data via the synapseclient from the command line. I received feedback from scientists across teams that this documentation needed to include best practices for keeping credentials secure. At this point, the tools we have available for that in our programmatic clients is caching credentials and using an apikey instead of a password (and creating a Synapse config file, although I view that as a slightly more advanced use case). I think adding support for the api key is a great interim solution.

Bruce Hoff
August 18, 2020, 6:19 PM

> If necessary it would be straighforward to add command line support for the api key, even if it is on the way out.
Yes, that's a reasonable approach. An alternative is to request that portals users create Synapse passwords to use with the CLI.



Jordan Kiang


Kelsey Montgomery




Kelsey Montgomery

Development Area


Release Version History


Slack Channel


Fix versions

Affects versions