doc/api/authentication.textile

   1 ---
   2 layout: default
   3 navsection: api
   4 title: Authentication
   5 navorder: 2
   6 ---
   7
   8 h1. Authentication
   9
  10 Every API request (except the authentication API itself) includes an @access_token@ parameter.
  11
  12 table(table table-bordered table-condensed).
  13 |Name|Type|Description|
  14 |access_token|string|Access token returned by OAuth 2.0 authorization procedure|
  15
  16 Many resources contain "actor" attributes like @modified_by@.  An @access_token@ uniquely identifies a client (application or project) and an end-user.
  17
  18 table(table table-bordered table-condensed).
  19 |Name|Type|Description|
  20 |modified_by_client|string|ID of API client|
  21 |modified_by_user|string|ID of authenticated user|
  22
  23 h2. Authorizing a client application
  24
  25 The Arvados API uses the "OAuth 2.0 protocol":http://tools.ietf.org/html/draft-ietf-oauth-v2-22 for authentication and authorization.
  26
  27 h3. Register your client application
  28
  29 Before an application can run on an Arvados cloud, it needs to be registered with the cloud.
  30
  31 That registration yields a @client_id@ and a @client_secret@.
  32
  33 h3. Obtain an access code
  34
  35 A client obtains an access code by means of a standard Oauth 2.0 flow. The access code is granted to it by an authorized user. The client requests one or more scopes, which translate to a set of requested permissions (reading, writing, etc). Unless the access is to be short-lived, a refresh token is also granted to the application.
  36
  37 h3. Refresh the access code (optional)
  38
  39 Access codes have a limited lifetime. A refresh token allows an application to request a new access token.