X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7024cc159936593350aaf7939d700102f6510787..051efbd3d843baa690b334e57fd09fad6a908bb9:/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 37eaa0a64a..3c668bdc56 100644 --- a/doc/api/methods/api_clients.html.textile.liquid +++ b/doc/api/methods/api_clients.html.textile.liquid @@ -6,44 +6,39 @@ title: "api_clients" ... -h1. api_clients +See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html -Required arguments are displayed in %{background:#ccffcc}green%. +API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/api_clients@ +UUID type: @ozdt8@ -h2. create +Required arguments are displayed in %{background:#ccffcc}green%. -Create a new ApiClient. +h2. Resource -Arguments: +Each ApiClient has, in addition to the usual "attributes of Arvados resources":{{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. - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path|| +h2. Methods -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,18 +46,17 @@ 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. @@ -72,21 +66,9 @@ 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|| +|filters|array|Conditions for filtering api_clients.|query|| -h2. update +h3. update Update attributes of an existing ApiClient.