doc/api/tokens.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 title: API Authorization
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 All requests to the API server must have an API token.  API tokens can be issued by going though the login flow, or created via the API.  At this time, only browser based applications can perform login from email/password.  Command line applications and services must use an API token provided via the @ARVADOS_API_TOKEN@ environment variable or configuration file.
  13
  14 h2. Browser login
  15
  16 Browser based applications can perform log in via the following highlevel flow:
  17
  18 # The web application presents a "login" link to @/login@ on the API server with a @return_to@ parameter provided in the query portion of the URL.  For example @https://{{ site.arvados_api_host }}/login?return_to=XXX@ , where  @return_to=XXX@ is the URL of the login page for the web application.
  19 # The "login" link takes the browser to the login page (this may involve several redirects)
  20 # The user logs in.  API server authenticates the user and issues a new API token.
  21 # The browser is redirected to the login page URL provided in @return_to=XXX@ with the addition of @?api_token=xxxxapitokenxxxx@.
  22 # The web application gets the login request with the included authorization token.
  23
  24 !{{site.baseurl}}/images/Session_Establishment.svg!
  25
  26 The "browser authentication process is documented in detail on the Arvados wiki.":https://dev.arvados.org/projects/arvados/wiki/Workbench_authentication_process
  27
  28 h2. User activation
  29
  30 "Creation and activation of new users is described here.":{{site.baseurl}}/admin/activation.html
  31
  32 h2. Creating tokens via the API
  33
  34 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.
  35
  36 h2. Trusted API clients
  37
  38 The "api_clients":{{site.baseurl}}/api/methods/api_clients.html resource determines if web applications that have gone through the browser login flow may create or list API tokens.
  39
  40 After the user has authenticated, but before an authorization token is issued and browser redirect sent (sending the browser back to the @return_to@ login page bearing @api_token@), the server strips the path and query portion from @return_to@ to get @url_prefix@.  The @url_prefix@ is used to find or create an ApiClient object.  The newly issued API client authorization (API token) is associated with this ApiClient object.
  41
  42 API clients may be marked as "trusted" by making an API call to create or update an "api_clients":{{site.baseurl}}/api/methods/api_clients.html resource and set the @is_trusted@ flag to @true@. An authorization token associated with a "trusted" client is permitted to list authorization tokens on "API client authorizations":{{site.baseurl}}/api/methods/api_client_authorizations.html .
  43
  44 A authorization token which is not associated with a trusted client may only use the @current@ method to query its own api_client_authorization object.  The "untrusted" token is forbidden performing any other operations on API client authorizations, such as listing other authorizations or creating new authorizations.
  45
  46 Authorization tokens which are not issued via the browser login flow (created directly via the API) will not have an associated api client.  This means authorization tokens created via the API are always "untrusted".
  47
  48 h2(#scopes). Scopes
  49
  50 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.
  51
  52 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.
  53
  54 As a special case, a scope of ["all"] allows all resources.
  55
  56 h3. Scope examples
  57
  58 A scope of @GET /arvados/v1/collections@ permits listing collections.
  59
  60 * Requests with different methods, such as creating a new collection using @POST /arvados/v1/collections@, will be rejected.
  61 * Requests to access other resources, such as @GET /arvados/v1/groups@, will be rejected.
  62 * Be aware that requests for specific records, such as @GET /arvados/v1/collections/962eh-4zz18-xi32mpz2621o8km@ will also be rejected.  This is because the scope @GET /arvados/v1/collections@ does not end in @/@
  63
  64 A scope of @GET /arvados/v1/collections/@ (with @/@ suffix) will permit access to individual collections.
  65
  66 * The request @GET /arvados/v1/collections/962eh-4zz18-xi32mpz2621o8km@ will succeed
  67 * Be aware that requests for listing @GET /arvados/v1/collections@ (no @/@ suffix) will be rejected, because it is not a match with the rule @GET /arvados/v1/collections/@
  68 * A listing request @GET /arvados/v1/collections/@ will have the trailing @/@ suffix trimmed before the scope check, as a result it will not match the rule @GET /arvados/v1/collections/@.
  69
  70 To allow both listing objects and requesting individual objects, include both in the scope: @["GET /arvados/v1/collections", "GET /arvados/v1/collections/"]@
  71
  72 A narrow scope such as @GET /arvados/v1/collections/962eh-4zz18-xi32mpz2621o8km@ will disallow listing objects as well as disallow requesting any object other than those listed in the scope.