Merge branch 'main' into 18842-arv-mount-disk-config

[arvados.git] / 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 c6b784482c6c97aa3964f7ec183e3270a794f55e..3f7abd4113924e650cbcc83bfc637c44432beab6 100644 (file)
--- a/doc/api/methods/api_clients.html.textile.liquid
+++ b/doc/api/methods/api_clients.html.textile.liquid
@@ -5,45 +5,49 @@ navmenu: API Methods
 title: "api_clients"
 
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
+API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_clients@
 
-Required arguments are displayed in %{background:#ccffcc}green%.
+Object type: @ozdt8@
 
+Example UUID: @zzzzz-ozdt8-0123456789abcde@
 
-h2. create
+h2. Resource
 
-Create a new ApiClient.
+The "api_clients" resource determines if web applications that have gone through the browser login flow may create or list API tokens.
 
-Arguments:
+Each ApiClient has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
 
 table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-|api_client|object||query||
-
-h2. delete
+|_. Attribute|_. Type|_. Description|_. Example|
+|name|string|||
+|url_prefix|string|||
+|is_trusted|boolean|Trusted by users to handle their API tokens (ApiClientAuthorizations).||
 
-Delete an existing ApiClient.
+h2. Methods
 
-Arguments:
+See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
 
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
+Required arguments are displayed in %{background:#ccffcc}green%.
 
-h2. destroy
+h3. create
 
-destroy api_clients
+Create a new ApiClient.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+|api_client|object||query||
 
-h2. get
+h3. delete
 
-Gets a ApiClient's metadata by UUID.
+Delete an existing ApiClient.
 
 Arguments:
 
@@ -51,42 +55,23 @@ table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
 
-h2. index
+h3. get
 
-index api_clients
+Gets a ApiClient's metadata by UUID.
 
 Arguments:
 
 table(table table-bordered table-condensed).
 |_. Argument |_. Type |_. Description |_. Location |_. Example |
-|order|string||query||
-|where|object||query||
+{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||
-|pageToken|string|Page token.|query||
-|q|string|Query string for searching api_clients.|query||
-|where|object|Conditions for filtering api_clients.|query||
-
-h2. show
-
-show api_clients
-
-Arguments:
-
-table(table table-bordered table-condensed).
-|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string||path||
+See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 
-h2. update
+h3. update
 
 Update attributes of an existing ApiClient.