projects
/
arvados.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
18205: Add container cost accounting fields.
[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 72c29437cd68c42b0d1078215314eebf40512bca..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"
...
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.
creat
e
+h2.
Resourc
e
-
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).
table(table table-bordered table-condensed).
-|_. A
rgument |_. Type |_. Description |_. Location |_. Example
|
-|
api_client|object||query
||
-
-h2. delete
+|_. A
ttribute|_. 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%.
-h
2. destroy
+h
3. create
-destroy api_clients
+Create a new ApiClient.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-
{background:#ccffcc}.|uuid|string||path
||
+
|api_client|object||query
||
-h
2. get
+h
3. delete
-
Gets a ApiClient's metadata by UUID
.
+
Delete an existing ApiClient
.
Arguments:
Arguments:
@@
-51,29
+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||
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
-h
2. lis
t
+h
3. ge
t
-
List api_clients
.
+
Gets a ApiClient's metadata by UUID
.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
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||
-
-h2. show
+{background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path||
-show api_clients
+h3. list
-Arguments:
+List api_clients.
-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
-h
2
. update
+h
3
. update
Update attributes of an existing ApiClient.
Update attributes of an existing ApiClient.