Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dc6c1efea8e6c89afa94df984d9291359cb04797 / . / docs / dyn / computeaccounts_alpha.users.html
blob: 9592be32ca0b4cd1469d97416c29a13599fb0974 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="computeaccounts_alpha.html">Compute Accounts API</a> . <a href="computeaccounts_alpha.users.html">users</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#addPublicKey">addPublicKey(project, user, body)</a></code></p>
79<p class="firstline">Adds a public key to the specified User resource with the data included in the request.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, user)</a></code></p>
82<p class="firstline">Deletes the specified User resource.</p>
83<p class="toc_element">
84 <code><a href="#get">get(project, user)</a></code></p>
85<p class="firstline">Returns the specified User resource.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(project, body)</a></code></p>
88<p class="firstline">Creates a User resource in the specified project using the data included in the request.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves a list of users contained within the specified project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#removePublicKey">removePublicKey(project, user, fingerprint)</a></code></p>
97<p class="firstline">Removes the specified public key from the user.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="addPublicKey">addPublicKey(project, user, body)</code>
101 <pre>Adds a public key to the specified User resource with the data included in the request.
102
103Args:
104 project: string, Project ID for this request. (required)
105 user: string, Name of the user for this request. (required)
106 body: object, The request body. (required)
107 The object takes the form of:
108
109{ # A public key for authenticating to guests.
110 "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
111 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
112 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
113 "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
114 "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
115}
116
117
118Returns:
119 An object of the form:
120
121 { # An operation resource, used to manage asynchronous API requests.
122 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
123 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
124 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
125 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
126 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
127 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
128 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
129 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
130 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
131 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
132 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
133 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
134 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
135 {
136 "message": "A String", # [Output Only] Optional human-readable details for this warning.
137 "code": "A String", # [Output Only] The warning type identifier for this warning.
138 "data": [ # [Output Only] Metadata for this warning in key: value format.
139 {
140 "value": "A String", # [Output Only] A warning data value corresponding to the key.
141 "key": "A String", # [Output Only] A key for the warning data.
142 },
143 ],
144 },
145 ],
146 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
147 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
148 "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
149 "name": "A String", # [Output Only] Name of the resource.
150 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
151 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
152 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
153 {
154 "message": "A String", # [Output Only] An optional, human-readable error message.
155 "code": "A String", # [Output Only] The error type identifier for this error.
156 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
157 },
158 ],
159 },
160 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
161 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
162 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="delete">delete(project, user)</code>
168 <pre>Deletes the specified User resource.
169
170Args:
171 project: string, Project ID for this request. (required)
172 user: string, Name of the user resource to delete. (required)
173
174Returns:
175 An object of the form:
176
177 { # An operation resource, used to manage asynchronous API requests.
178 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
179 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
180 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
181 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
182 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
183 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
184 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
185 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
186 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
187 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
188 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
189 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
190 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
191 {
192 "message": "A String", # [Output Only] Optional human-readable details for this warning.
193 "code": "A String", # [Output Only] The warning type identifier for this warning.
194 "data": [ # [Output Only] Metadata for this warning in key: value format.
195 {
196 "value": "A String", # [Output Only] A warning data value corresponding to the key.
197 "key": "A String", # [Output Only] A key for the warning data.
198 },
199 ],
200 },
201 ],
202 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
203 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
204 "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
205 "name": "A String", # [Output Only] Name of the resource.
206 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
207 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
208 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
209 {
210 "message": "A String", # [Output Only] An optional, human-readable error message.
211 "code": "A String", # [Output Only] The error type identifier for this error.
212 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
213 },
214 ],
215 },
216 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
217 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
218 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="get">get(project, user)</code>
224 <pre>Returns the specified User resource.
225
226Args:
227 project: string, Project ID for this request. (required)
228 user: string, Name of the user resource to return. (required)
229
230Returns:
231 An object of the form:
232
233 { # A User resource.
234 "kind": "computeaccounts#user", # [Output Only] Type of the resource. Always computeaccounts#user for users.
235 "name": "A String", # Name of the resource; provided by the client when the resource is created.
236 "publicKeys": [ # [Output Only] Public keys that this user may use to login.
237 { # A public key for authenticating to guests.
238 "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
239 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
240 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
241 "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
242 "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
243 },
244 ],
245 "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
246 "A String",
247 ],
248 "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
249 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
250 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
251 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
252 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
253 }</pre>
254</div>
255
256<div class="method">
257 <code class="details" id="insert">insert(project, body)</code>
258 <pre>Creates a User resource in the specified project using the data included in the request.
259
260Args:
261 project: string, Project ID for this request. (required)
262 body: object, The request body. (required)
263 The object takes the form of:
264
265{ # A User resource.
266 "kind": "computeaccounts#user", # [Output Only] Type of the resource. Always computeaccounts#user for users.
267 "name": "A String", # Name of the resource; provided by the client when the resource is created.
268 "publicKeys": [ # [Output Only] Public keys that this user may use to login.
269 { # A public key for authenticating to guests.
270 "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
271 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
272 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
273 "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
274 "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
275 },
276 ],
277 "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
278 "A String",
279 ],
280 "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
281 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
282 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
283 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
284 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
285 }
286
287
288Returns:
289 An object of the form:
290
291 { # An operation resource, used to manage asynchronous API requests.
292 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
293 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
294 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
295 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
296 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
297 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
298 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
299 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
300 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
301 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
302 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
303 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
304 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
305 {
306 "message": "A String", # [Output Only] Optional human-readable details for this warning.
307 "code": "A String", # [Output Only] The warning type identifier for this warning.
308 "data": [ # [Output Only] Metadata for this warning in key: value format.
309 {
310 "value": "A String", # [Output Only] A warning data value corresponding to the key.
311 "key": "A String", # [Output Only] A key for the warning data.
312 },
313 ],
314 },
315 ],
316 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
317 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
318 "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
319 "name": "A String", # [Output Only] Name of the resource.
320 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
321 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
322 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
323 {
324 "message": "A String", # [Output Only] An optional, human-readable error message.
325 "code": "A String", # [Output Only] The error type identifier for this error.
326 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
327 },
328 ],
329 },
330 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
331 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
332 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
333 }</pre>
334</div>
335
336<div class="method">
337 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
338 <pre>Retrieves a list of users contained within the specified project.
339
340Args:
341 project: string, Project ID for this request. (required)
342 orderBy: string, A parameter
343 maxResults: integer, Maximum count of results to be returned.
344 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
345 filter: string, Filter expression for filtering listed resources.
346
347Returns:
348 An object of the form:
349
350 {
351 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
352 "items": [ # [Output Only] A list of User resources.
353 { # A User resource.
354 "kind": "computeaccounts#user", # [Output Only] Type of the resource. Always computeaccounts#user for users.
355 "name": "A String", # Name of the resource; provided by the client when the resource is created.
356 "publicKeys": [ # [Output Only] Public keys that this user may use to login.
357 { # A public key for authenticating to guests.
358 "expirationTimestamp": "A String", # Optional expiration timestamp. If provided, the timestamp must be in RFC3339 text format. If not provided, the public key never expires.
359 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
360 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
361 "key": "A String", # Public key text in SSH format, defined by RFC4253 section 6.6.
362 "fingerprint": "A String", # [Output Only] The fingerprint of the key is defined by RFC4716 to be the MD5 digest of the public key.
363 },
364 ],
365 "groups": [ # [Output Only] A list of URLs to Group resources who contain the user. Users are only members of groups in the same project.
366 "A String",
367 ],
368 "owner": "A String", # Email address of account's owner. This account will be validated to make sure it exists. The email can belong to any domain, but it must be tied to a Google account.
369 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
370 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
371 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
372 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
373 },
374 ],
375 "kind": "computeaccounts#userList", # [Output Only] Type of resource. Always computeaccounts#userList for lists of users.
376 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
377 "selfLink": "A String", # [Output Only] Server defined URL for this resource.
378 }</pre>
379</div>
380
381<div class="method">
382 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
383 <pre>Retrieves the next page of results.
384
385Args:
386 previous_request: The request for the previous page. (required)
387 previous_response: The response from the request for the previous page. (required)
388
389Returns:
390 A request object that you can call 'execute()' on to request the next
391 page. Returns None if there are no more items in the collection.
392 </pre>
393</div>
394
395<div class="method">
396 <code class="details" id="removePublicKey">removePublicKey(project, user, fingerprint)</code>
397 <pre>Removes the specified public key from the user.
398
399Args:
400 project: string, Project ID for this request. (required)
401 user: string, Name of the user for this request. (required)
402 fingerprint: string, The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key. (required)
403
404Returns:
405 An object of the form:
406
407 { # An operation resource, used to manage asynchronous API requests.
408 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
409 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
410 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
411 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
412 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
413 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
414 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
415 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
416 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
417 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
418 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
419 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
420 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
421 {
422 "message": "A String", # [Output Only] Optional human-readable details for this warning.
423 "code": "A String", # [Output Only] The warning type identifier for this warning.
424 "data": [ # [Output Only] Metadata for this warning in key: value format.
425 {
426 "value": "A String", # [Output Only] A warning data value corresponding to the key.
427 "key": "A String", # [Output Only] A key for the warning data.
428 },
429 ],
430 },
431 ],
432 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
433 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
434 "kind": "computeaccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
435 "name": "A String", # [Output Only] Name of the resource.
436 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
437 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
438 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
439 {
440 "message": "A String", # [Output Only] An optional, human-readable error message.
441 "code": "A String", # [Output Only] The error type identifier for this error.
442 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
443 },
444 ],
445 },
446 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
447 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
448 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
449 }</pre>
450</div>
451
452</body></html>