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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "api_clients"
   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_clients@
  12
  13 UUID type: @ozdt8@
  14
  15 Required arguments are displayed in %{background:#ccffcc}green%.
  16
  17 h2. Resource
  18
  19 The "api_clients" resource determines if web applications that have gone through the browser login flow may create or list API tokens.
  20
  21 Each ApiClient has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  22
  23 table(table table-bordered table-condensed).
  24 |_. Attribute|_. Type|_. Description|_. Example|
  25 |name|string|||
  26 |url_prefix|string|||
  27 |is_trusted|boolean|Trusted by users to handle their API tokens (ApiClientAuthorizations).||
  28
  29 h2. Methods
  30
  31 h3. create
  32
  33 Create a new ApiClient.
  34
  35 Arguments:
  36
  37 table(table table-bordered table-condensed).
  38 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  39 |api_client|object||query||
  40
  41 h3. delete
  42
  43 Delete an existing ApiClient.
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  49 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
  50
  51 h3. get
  52
  53 Gets a ApiClient's metadata by UUID.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
  60
  61 h3. list
  62
  63 List api_clients.
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69 |limit|integer (default 100)|Maximum number of api_clients to return.|query||
  70 |order|string|Order in which to return matching api_clients.|query||
  71 |filters|array|Conditions for filtering api_clients.|query||
  72
  73 h3. update
  74
  75 Update attributes of an existing ApiClient.
  76
  77 Arguments:
  78
  79 table(table table-bordered table-condensed).
  80 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  81 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
  82 |api_client|object||query||