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 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_clients@
  10
  11 Object type: @ozdt8@
  12
  13 Example UUID: @zzzzz-ozdt8-0123456789abcde@
  14
  15 h2. Resource
  16
  17 The "api_clients" resource determines if web applications that have gone through the browser login flow may create or list API tokens.
  18
  19 Each ApiClient has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Attribute|_. Type|_. Description|_. Example|
  23 |name|string|||
  24 |url_prefix|string|||
  25 |is_trusted|boolean|Trusted by users to handle their API tokens (ApiClientAuthorizations).||
  26
  27 h2. Methods
  28
  29 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  30
  31 Required arguments are displayed in %{background:#ccffcc}green%.
  32
  33 h3. create
  34
  35 Create a new ApiClient.
  36
  37 Arguments:
  38
  39 table(table table-bordered table-condensed).
  40 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  41 |api_client|object||query||
  42
  43 h3. delete
  44
  45 Delete an existing ApiClient.
  46
  47 Arguments:
  48
  49 table(table table-bordered table-condensed).
  50 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  51 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
  52
  53 h3. get
  54
  55 Gets a ApiClient's metadata by UUID.
  56
  57 Arguments:
  58
  59 table(table table-bordered table-condensed).
  60 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  61 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
  62
  63 h3. list
  64
  65 List api_clients.
  66
  67 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  68
  69 h3. update
  70
  71 Update attributes of an existing ApiClient.
  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 ApiClient in question.|path||
  78 |api_client|object||query||