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