16129: Link to collection sharing link example.
authorPeter Amstutz <peter.amstutz@curii.com>
Thu, 12 Mar 2020 21:46:21 +0000 (17:46 -0400)
committerPeter Amstutz <peter.amstutz@curii.com>
Thu, 12 Mar 2020 21:46:21 +0000 (17:46 -0400)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

doc/admin/scoped-tokens.html.textile.liquid
doc/sdk/python/cookbook.html.textile.liquid

index 477fc396eced39c0eec74c7bbc44ba332992ee1c..44da1d4d30bbe41f9f4c05524ac6e1b3792c2499 100644 (file)
@@ -6,6 +6,8 @@ title: Securing API access with scoped tokens
 
 By default, Arvados API tokens grant unlimited access to a user account, and admin account tokens have unlimited access to the whole system.  If you want to grant restricted access to a user account, you can create a "scoped token" which is an Arvados API token which is limited to accessing specific APIs.
 
+One use of token scopes is to grant access to a collection to users who do not have an Arvados accounts on your cluster.  This is done by creating scoped token that only allows getting a specific collection.  See "Create a collection sharing link":{{site.baseurl}}/sdk/python/cookbook.html#sharing_link
+
 h2. Defining scopes
 
 A "scope" consists of a HTTP method and API path.  A token can have multiple scopes.  Token scopes act as a whitelist, and the API server checks the HTTP method and the API path of every request against the scopes of the request token.
index 34f0a5014a58174b499b7d47ba089231efe2a9e0..bd7f64b33d068175b3219f1c962f671777fd3173 100644 (file)
@@ -162,7 +162,7 @@ for c in collection:
     print(collection.open(c).read())
 {% endcodeblock %}
 
-h2. Create a collection sharing link
+h2(#sharing_link). Create a collection sharing link
 
 {% codeblock as python %}
 import arvados