doc/api/methods/api_client_authorizations.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "api_client_authorizations"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_client_authorizations@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. Resource
  16
  17 An ApiClientAuthorization is not a generic Arvados resource.  The full list of properties that belong to an ApiClientAuthorization is:
  18
  19 table(table table-bordered table-condensed).
  20 |_. Attribute|_. Type|_. Description|_. Example|
  21 |api_token|string|||
  22 |api_client_id|integer|||
  23 |user_id|integer|||
  24 |created_by_ip_address|string|||
  25 |last_used_by_ip_address|string|||
  26 |last_used_at|datetime|||
  27 |expires_at|datetime|||
  28 |default_owner_uuid|string|||
  29 |scopes|array|||
  30
  31 h2. Methods
  32
  33 h3. create
  34
  35 Create a new ApiClientAuthorization.
  36
  37 Arguments:
  38
  39 table(table table-bordered table-condensed).
  40 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  41 |api_client_authorization|object||query||
  42
  43 h3. create_system_auth
  44
  45 create_system_auth api_client_authorizations
  46
  47 Arguments:
  48
  49 table(table table-bordered table-condensed).
  50 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  51 |api_client_id|integer||query||
  52 |scopes|array||query||
  53
  54 h3. delete
  55
  56 Delete an existing ApiClientAuthorization.
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  63
  64 h3. get
  65
  66 Gets a ApiClientAuthorization's metadata by UUID.
  67
  68 Arguments:
  69
  70 table(table table-bordered table-condensed).
  71 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  72 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  73
  74 h3. list
  75
  76 List api_client_authorizations.
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82 |limit|integer (default 100)|Maximum number of api_client_authorizations to return.|query||
  83 |order|string|Order in which to return matching api_client_authorizations.|query||
  84 |filters|array|Conditions for filtering api_client_authorizations.|query||
  85
  86 h3. update
  87
  88 Update attributes of an existing ApiClientAuthorization.
  89
  90 Arguments:
  91
  92 table(table table-bordered table-condensed).
  93 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  94 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  95 |api_client_authorization|object||query||