You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Credentials.rst
+7-3Lines changed: 7 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,15 @@ Use `username` and `password` to login as follows::
11
11
import synapseclient
12
12
syn = synapseclient.login("username", "password")
13
13
14
+
Alternately you can login using a personal access token obtained from synapse.org under your Settings. Note that a token must minimally have the *view* scope to be used with the Synapse Python Client.
15
+
16
+
::
17
+
18
+
syn = synapseclient.login(authToken="authtoken")
14
19
15
20
Use `.synapseConfig`
16
21
====================
17
-
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.
22
+
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.
18
23
19
24
When installing the Synapse Python client, the `.synapseConfig` is added to your home directory. Open the `.synapseConfig` file and find the following section::
20
25
@@ -23,8 +28,7 @@ When installing the Synapse Python client, the `.synapseConfig` is added to your
23
28
#password = <password>
24
29
#authtoken = <authtoken>
25
30
26
-
To enable this section, uncomment it. You will only need to specify either a `username` and `password` pair, or an `authtoken`. For security purposes, we recommend that you use `authtoken` instead of your `password`.
27
-
You can generate a personal access token to that can be used in the .synapseConfig as an authtoken at synapse.org under your Settings. A token must minimally have the *view* scope to be used with the Synapse Python Client.
31
+
To enable this section, uncomment it. You will only need to specify either a `username` and `password` pair, or an `authtoken`. For security purposes, we recommend that you use `authtoken` instead of your `password`. A personal access token generated from your synapse.org Settings can be used as your *.synapseConfig* authtoken.
@@ -79,7 +79,7 @@ <h2>Login<a class="headerlink" href="#login" title="Permalink to this headline">
79
79
<h2>Synapse<aclass="headerlink" href="#synapse" title="Permalink to this headline">¶</a></h2>
80
80
<dlclass="py class">
81
81
<dtid="synapseclient.Synapse">
82
-
<emclass="property">class </em><codeclass="sig-prename descclassname">synapseclient.</code><codeclass="sig-name descname">Synapse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">repoEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">authEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">fileHandleEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">portalEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">debug</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">skip_checks</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">configPath</span><spanclass="o">=</span><spanclass="default_value">'/Users/jkiang/.synapseConfig'</span></em>, <emclass="sig-param"><spanclass="n">requests_session</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#synapseclient.Synapse" title="Permalink to this definition">¶</a></dt>
82
+
<emclass="property">class </em><codeclass="sig-prename descclassname">synapseclient.</code><codeclass="sig-name descname">Synapse</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">repoEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">authEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">fileHandleEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">portalEndpoint</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">debug</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">skip_checks</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">configPath</span><spanclass="o">=</span><spanclass="default_value">'/Users/jkiang/.synapseConfig'</span></em>, <emclass="sig-param"><spanclass="n">requests_session</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">cache_root_dir</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#synapseclient.Synapse" title="Permalink to this definition">¶</a></dt>
83
83
<dd><p>Constructs a Python client object for the Synapse repository service</p>
84
84
<dlclass="field-list simple">
85
85
<dtclass="field-odd">Parameters</dt>
@@ -203,6 +203,9 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
203
203
<li><p><strong>sts_enabled</strong> – Whether this storage location should be STS enabled</p></li>
204
204
</ul>
205
205
</dd>
206
+
<dtclass="field-even">Returns</dt>
207
+
<ddclass="field-even"><p>a 3-tuple of the synapse Folder, a the storage location setting, and the project setting dictionaries</p>
208
+
</dd>
206
209
</dl>
207
210
</dd></dl>
208
211
@@ -872,13 +875,28 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
872
875
</dl>
873
876
</dd></dl>
874
877
878
+
<dlclass="py method">
879
+
<dtid="synapseclient.Synapse.is_certified">
880
+
<codeclass="sig-name descname">is_certified</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">user</span><spanclass="p">:</span><spanclass="n">Union<spanclass="p">[</span>str<spanclass="p">, </span>int<spanclass="p">]</span></span></em><spanclass="sig-paren">)</span> → bool<aclass="headerlink" href="#synapseclient.Synapse.is_certified" title="Permalink to this definition">¶</a></dt>
881
+
<dd><p>Determines whether a Synapse user is a certified user.</p>
882
+
<dlclass="field-list simple">
883
+
<dtclass="field-odd">Params user</dt>
884
+
<ddclass="field-odd"><p>Synapse username or Id</p>
885
+
</dd>
886
+
<dtclass="field-even">Returns</dt>
887
+
<ddclass="field-even"><p>True if the Synapse user is certified</p>
888
+
</dd>
889
+
</dl>
890
+
</dd></dl>
891
+
875
892
<dlclass="py method">
876
893
<dtid="synapseclient.Synapse.login">
877
-
<codeclass="sig-name descname">login</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">email</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">password</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">apiKey</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sessionToken</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">rememberMe</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">silent</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">forced</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#synapseclient.Synapse.login" title="Permalink to this definition">¶</a></dt>
894
+
<codeclass="sig-name descname">login</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">email</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">password</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">apiKey</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">sessionToken</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">rememberMe</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">silent</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">forced</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">authToken</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#synapseclient.Synapse.login" title="Permalink to this definition">¶</a></dt>
878
895
<dd><p>Valid combinations of login() arguments:</p>
879
896
<ulclass="simple">
880
897
<li><p>email/username and password</p></li>
881
898
<li><p>email/username and apiKey (Base64 encoded string)</p></li>
0 commit comments