doc/api/schema/ApiClientAuthorization.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: ApiClientAuthorization
   6
   7 ...
   8
   9
  10
  11 A **ApiClientAuthorization** represents the API authorization token that has been issued to each "ApiClient":ApiClient.html known to this Arvados instance.
  12
  13 h2. Methods
  14
  15 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  16
  17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_client_authorizations@
  18
  19 h2. Creation
  20
  21 h3. Prerequisites
  22
  23 Prerequisites for creating a ApiClientAuthorization.
  24
  25 h3. Side effects
  26
  27 Side effects of creating a ApiClientAuthorization.
  28
  29 h2. Resources
  30
  31 An ApiClientAuthorization is not a generic Arvados resource.  The full list of properties that belong to an ApiClientAuthorization is:
  32
  33 table(table table-bordered table-condensed).
  34 |_. Attribute|_. Type|_. Description|_. Example|
  35 |api_token|string|||
  36 |api_client_id|integer|||
  37 |user_id|integer|||
  38 |created_by_ip_address|string|||
  39 |last_used_by_ip_address|string|||
  40 |last_used_at|datetime|||
  41 |expires_at|datetime|||
  42 |updated_at|datetime|||
  43 |default_owner_uuid|string|||
  44 |scopes|Array|||