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
  16 h2. create
  17
  18 Create a new ApiClientAuthorization.
  19
  20 Arguments:
  21
  22 table(table table-bordered table-condensed).
  23 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  24 |api_client_authorization|object||query||
  25
  26 h2. create_system_auth
  27
  28 create_system_auth api_client_authorizations
  29
  30 Arguments:
  31
  32 table(table table-bordered table-condensed).
  33 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  34 |api_client_id|integer||query||
  35 |scopes|array||query||
  36
  37 h2. delete
  38
  39 Delete an existing ApiClientAuthorization.
  40
  41 Arguments:
  42
  43 table(table table-bordered table-condensed).
  44 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  45 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  46
  47 h2. get
  48
  49 Gets a ApiClientAuthorization's metadata by UUID.
  50
  51 Arguments:
  52
  53 table(table table-bordered table-condensed).
  54 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  55 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  56
  57 h2. list
  58
  59 List api_client_authorizations.
  60
  61 Arguments:
  62
  63 table(table table-bordered table-condensed).
  64 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  65 |limit|integer (default 100)|Maximum number of api_client_authorizations to return.|query||
  66 |order|string|Order in which to return matching api_client_authorizations.|query||
  67 |filters|array|Conditions for filtering api_client_authorizations.|query||
  68
  69 h2. update
  70
  71 Update attributes of an existing ApiClientAuthorization.
  72
  73 Arguments:
  74
  75 table(table table-bordered table-condensed).
  76 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  77 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
  78 |api_client_authorization|object||query||