doc/api/ApiClientAuthorization.textile

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