X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/060d38d627bd1e51dd2b3c6e7de9af6aa7d7b6f3..426103b2d2f071ab0d57b3f9aaea58a3f8455c4f:/doc/api/tokens.html.textile.liquid diff --git a/doc/api/tokens.html.textile.liquid b/doc/api/tokens.html.textile.liquid index 922df5ab9d..1846d60b0e 100644 --- a/doc/api/tokens.html.textile.liquid +++ b/doc/api/tokens.html.textile.liquid @@ -25,6 +25,10 @@ Browser based applications can perform log in via the following highlevel flow: The "browser authentication process is documented in detail on the Arvados wiki.":https://dev.arvados.org/projects/arvados/wiki/Workbench_authentication_process +h2. User activation + +"Creation and activation of new users is described here.":{{site.baseurl}}/admin/activation.html + h2. Creating tokens via the API The browser login method above issues a new token. Using that token, it is possible to make API calls to create additional tokens. To do so, use the @create@ method of the "API client authorizations":{{site.baseurl}}/api/methods/api_client_authorizations.html resource. @@ -45,9 +49,11 @@ h2(#scopes). Scopes Scopes can restrict a token so it may only access certain resources. This is in addition to normal permission checks for the user associated with the token. -Each entry in scopes consists of a @request_method@ and @request_path@, where the @request_method@ is a HTTP method (one of @GET@, @POST@, @PUT@ or @DELETE@) and @request_path@ is the request URI. A given request is permitted if it matches a scopes exactly, or the scope ends with @/@ and the request string is a prefix of the scope. +Each entry in scopes consists of a @request_method@ and @request_path@. The @request_method@ is a HTTP method (one of @GET@, @POST@, @PATCH@ or @DELETE@) and @request_path@ is the request URI. A given request is permitted if it matches a scopes exactly, or the scope ends with @/@ and the request string is a prefix of the scope. + +As a special case, a scope of @["all"]@ allows all resources. This is the default if no scope is given. -As a special case, a scope of ["all"] allows all resources. +Using scopes is also described on the "Securing API access with scoped tokens":{{site.baseurl}}/admin/scoped-tokens.html page of the admin documentation. h3. Scope examples