Look for repo_name in VM link
[arvados.git] / doc / api / methods / api_client_authorizations.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 navmenu: API Methods
5 title: "api_client_authorizations"
6
7 ...
8
9
10
11 Required arguments are displayed in %{background:#ccffcc}green%.
12
13
14 h2. create
15
16 Create a new ApiClientAuthorization.
17
18 Arguments:
19
20 table(table table-bordered table-condensed).
21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
22 |api_client_authorization|object||query||
23
24 h2. create_system_auth
25
26 create_system_auth api_client_authorizations
27
28 Arguments:
29
30 table(table table-bordered table-condensed).
31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
32 |api_client_id|integer||query||
33 |scopes|array||query||
34
35 h2. delete
36
37 Delete an existing ApiClientAuthorization.
38
39 Arguments:
40
41 table(table table-bordered table-condensed).
42 |_. Argument |_. Type |_. Description |_. Location |_. Example |
43 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
44
45 h2. destroy
46
47 destroy api_client_authorizations
48
49 Arguments:
50
51 table(table table-bordered table-condensed).
52 |_. Argument |_. Type |_. Description |_. Location |_. Example |
53 {background:#ccffcc}.|uuid|string||path||
54
55 h2. get
56
57 Gets a ApiClientAuthorization's metadata by UUID.
58
59 Arguments:
60
61 table(table table-bordered table-condensed).
62 |_. Argument |_. Type |_. Description |_. Location |_. Example |
63 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
64
65 h2. index
66
67 index api_client_authorizations
68
69 Arguments:
70
71 table(table table-bordered table-condensed).
72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
73 |order|string||query||
74 |where|object||query||
75
76 h2. list
77
78 List api_client_authorizations.
79
80 Arguments:
81
82 table(table table-bordered table-condensed).
83 |_. Argument |_. Type |_. Description |_. Location |_. Example |
84 |limit|integer (default 100)|Maximum number of api_client_authorizations to return.|query||
85 |order|string|Order in which to return matching api_client_authorizations.|query||
86 |pageToken|string|Page token.|query||
87 |q|string|Query string for searching api_client_authorizations.|query||
88 |where|object|Conditions for filtering api_client_authorizations.|query||
89
90 h2. show
91
92 show api_client_authorizations
93
94 Arguments:
95
96 table(table table-bordered table-condensed).
97 |_. Argument |_. Type |_. Description |_. Location |_. Example |
98 {background:#ccffcc}.|uuid|string||path||
99
100 h2. update
101
102 Update attributes of an existing ApiClientAuthorization.
103
104 Arguments:
105
106 table(table table-bordered table-condensed).
107 |_. Argument |_. Type |_. Description |_. Location |_. Example |
108 {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path||
109 |api_client_authorization|object||query||