X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/1c5176d87df0dbd25db6ff1fb2ab82ae17472145..8674cfd50ad24171de7d157813819f3383c3353b:/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 056cc30812..3f7abd4113 100644 --- a/doc/api/methods/api_clients.html.textile.liquid +++ b/doc/api/methods/api_clients.html.textile.liquid @@ -5,14 +5,37 @@ 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@ +Object type: @ozdt8@ + +Example UUID: @zzzzz-ozdt8-0123456789abcde@ + +h2. Resource + +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 "Common resource fields":{{site.baseurl}}/api/resources.html: + +table(table table-bordered table-condensed). +|_. Attribute|_. Type|_. Description|_. Example| +|name|string||| +|url_prefix|string||| +|is_trusted|boolean|Trusted by users to handle their API tokens (ApiClientAuthorizations).|| + +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%. -h2. create +h3. create Create a new ApiClient. @@ -22,7 +45,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |api_client|object||query|| -h2. delete +h3. delete Delete an existing ApiClient. @@ -32,7 +55,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path|| -h2. get +h3. get Gets a ApiClient's metadata by UUID. @@ -42,19 +65,13 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path|| -h2. list +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 -h2. update +h3. update Update attributes of an existing ApiClient.