X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0f2ab548f96e8604a929e0636517f634b7dfb0ad..0557b1dbb08d5328e29eac805824a8e21040f582:/doc/api/methods/api_clients.html.textile.liquid diff --git a/doc/api/methods/api_clients.html.textile.liquid b/doc/api/methods/api_clients.html.textile.liquid index d7c834ef71..3f7abd4113 100644 --- a/doc/api/methods/api_clients.html.textile.liquid +++ b/doc/api/methods/api_clients.html.textile.liquid @@ -5,20 +5,23 @@ navmenu: API Methods title: "api_clients" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_clients@ -UUID type: @ozdt8@ +Object type: @ozdt8@ -Required arguments are displayed in %{background:#ccffcc}green%. +Example UUID: @zzzzz-ozdt8-0123456789abcde@ h2. Resource -which are permitted to access the API server. Applications must provide +The "api_clients" resource determines if web applications that have gone through the browser login flow may create or list API tokens. -Each ApiClient has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: +Each ApiClient has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| @@ -28,6 +31,10 @@ table(table table-bordered table-condensed). h2. Methods +See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@. + +Required arguments are displayed in %{background:#ccffcc}green%. + h3. create Create a new ApiClient. @@ -62,13 +69,7 @@ h3. list List api_clients. -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|limit|integer (default 100)|Maximum number of api_clients to return.|query|| -|order|string|Order in which to return matching api_clients.|query|| -|filters|array|Conditions for filtering api_clients.|query|| +See "common resource list method.":{{site.baseurl}}/api/methods.html#index h3. update