foreman_api 0.0.10 → 0.0.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. data/.yardopts +4 -0
  2. data/Gemfile +5 -0
  3. data/README.rdoc +23 -4
  4. data/doc/ForemanApi/Resources/Architecture.html +902 -0
  5. data/doc/ForemanApi/Resources/Audit.html +500 -0
  6. data/doc/ForemanApi/Resources/AuthSourceLdap.html +916 -0
  7. data/doc/ForemanApi/Resources/Bookmark.html +884 -0
  8. data/doc/ForemanApi/Resources/CommonParameter.html +902 -0
  9. data/doc/ForemanApi/Resources/ComputeResource.html +940 -0
  10. data/doc/ForemanApi/Resources/ConfigTemplate.html +1160 -0
  11. data/doc/ForemanApi/Resources/Dashboard.html +336 -0
  12. data/doc/ForemanApi/Resources/Domain.html +914 -0
  13. data/doc/ForemanApi/Resources/Environment.html +898 -0
  14. data/doc/ForemanApi/Resources/FactValue.html +375 -0
  15. data/doc/ForemanApi/Resources/Home.html +417 -0
  16. data/doc/ForemanApi/Resources/Host.html +1091 -0
  17. data/doc/ForemanApi/Resources/Hostgroup.html +934 -0
  18. data/doc/ForemanApi/Resources/Image.html +963 -0
  19. data/doc/ForemanApi/Resources/LookupKey.html +918 -0
  20. data/doc/ForemanApi/Resources/Medium.html +920 -0
  21. data/doc/ForemanApi/Resources/Model.html +910 -0
  22. data/doc/ForemanApi/Resources/OperatingSystem.html +1057 -0
  23. data/doc/ForemanApi/Resources/Ptable.html +906 -0
  24. data/doc/ForemanApi/Resources/Puppetclass.html +898 -0
  25. data/doc/ForemanApi/Resources/Report.html +625 -0
  26. data/doc/ForemanApi/Resources/Role.html +872 -0
  27. data/doc/ForemanApi/Resources/Setting.html +641 -0
  28. data/doc/ForemanApi/Resources/SmartProxy.html +889 -0
  29. data/doc/ForemanApi/Resources/Subnet.html +954 -0
  30. data/doc/ForemanApi/Resources/TemplateKind.html +349 -0
  31. data/doc/ForemanApi/Resources/User.html +920 -0
  32. data/doc/ForemanApi/Resources/Usergroup.html +872 -0
  33. data/doc/ForemanApi/Resources.html +117 -0
  34. data/doc/ForemanApi.html +117 -0
  35. data/doc/_index.html +449 -0
  36. data/doc/class_list.html +53 -0
  37. data/doc/css/common.css +1 -0
  38. data/doc/css/full_list.css +57 -0
  39. data/doc/css/style.css +328 -0
  40. data/doc/file.MIT-LICENSE.html +93 -0
  41. data/doc/file.README.html +129 -0
  42. data/doc/file_list.html +58 -0
  43. data/doc/frames.html +28 -0
  44. data/doc/index.html +129 -0
  45. data/doc/js/app.js +214 -0
  46. data/doc/js/full_list.js +173 -0
  47. data/doc/js/jquery.js +4 -0
  48. data/doc/method_list.html +1300 -0
  49. data/doc/top-level-namespace.html +112 -0
  50. data/foreman_api.gemspec +5 -2
  51. data/lib/foreman_api/base.rb +129 -0
  52. data/lib/foreman_api/resources/architecture.rb +17 -7
  53. data/lib/foreman_api/resources/audit.rb +7 -4
  54. data/lib/foreman_api/resources/auth_source_ldap.rb +35 -7
  55. data/lib/foreman_api/resources/bookmark.rb +19 -7
  56. data/lib/foreman_api/resources/common_parameter.rb +17 -7
  57. data/lib/foreman_api/resources/compute_resource.rb +33 -7
  58. data/lib/foreman_api/resources/config_template.rb +28 -9
  59. data/lib/foreman_api/resources/dashboard.rb +3 -3
  60. data/lib/foreman_api/resources/domain.rb +21 -7
  61. data/lib/foreman_api/resources/environment.rb +15 -7
  62. data/lib/foreman_api/resources/fact_value.rb +6 -3
  63. data/lib/foreman_api/resources/home.rb +2 -4
  64. data/lib/foreman_api/resources/host.rb +50 -8
  65. data/lib/foreman_api/resources/hostgroup.rb +33 -7
  66. data/lib/foreman_api/resources/image.rb +30 -7
  67. data/lib/foreman_api/resources/lookup_key.rb +25 -7
  68. data/lib/foreman_api/resources/medium.rb +19 -7
  69. data/lib/foreman_api/resources/model.rb +21 -7
  70. data/lib/foreman_api/resources/operating_system.rb +26 -8
  71. data/lib/foreman_api/resources/ptable.rb +19 -7
  72. data/lib/foreman_api/resources/puppetclass.rb +15 -7
  73. data/lib/foreman_api/resources/report.rb +8 -5
  74. data/lib/foreman_api/resources/role.rb +13 -7
  75. data/lib/foreman_api/resources/setting.rb +11 -5
  76. data/lib/foreman_api/resources/smart_proxy.rb +16 -7
  77. data/lib/foreman_api/resources/subnet.rb +39 -7
  78. data/lib/foreman_api/resources/template_kind.rb +4 -3
  79. data/lib/foreman_api/resources/user.rb +26 -7
  80. data/lib/foreman_api/resources/usergroup.rb +13 -7
  81. data/lib/foreman_api/rest_client_oauth.rb +19 -0
  82. data/lib/foreman_api/version.rb +1 -1
  83. data/lib/foreman_api.rb +6 -10
  84. metadata +51 -18
data/doc/ForemanApi/Resources/User.html ADDED
@@ -0,0 +1,920 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: ForemanApi::Resources::User
8
+
9
+ &mdash; Documentation by YARD 0.8.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (U)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resources.html" title="ForemanApi::Resources (module)">Resources</a></span></span>
36
+ &raquo;
37
+ <span class="title">User</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: ForemanApi::Resources::User
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Base</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Base</li>
82
+
83
+ <li class="next">ForemanApi::Resources::User</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/foreman_api/resources/user.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <h2>
113
+ Class Method Summary
114
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
115
+ </h2>
116
+
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <span class="summary_desc"><div class='inline'></div></span>
137
+
138
+ </li>
139
+
140
+
141
+ </ul>
142
+
143
+ <h2>
144
+ Instance Method Summary
145
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
146
+ </h2>
147
+
148
+ <ul class="summary">
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</strong>(params = { }, headers = { }) </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'></div></span>
168
+
169
+ </li>
170
+
171
+
172
+ <li class="public ">
173
+ <span class="summary_signature">
174
+
175
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong>(params = { }, headers = { }) </a>
176
+
177
+
178
+
179
+ </span>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'></div></span>
190
+
191
+ </li>
192
+
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</strong>(params = { }, headers = { }) </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'></div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#show-instance_method" title="#show (instance method)">- (Object) <strong>show</strong>(params = { }, headers = { }) </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'></div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</strong>(params = { }, headers = { }) </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <span class="summary_desc"><div class='inline'></div></span>
256
+
257
+ </li>
258
+
259
+
260
+ </ul>
261
+
262
+
263
+
264
+
265
+
266
+ <div id="class_method_details" class="method_details_list">
267
+ <h2>Class Method Details</h2>
268
+
269
+
270
+ <div class="method_details first">
271
+ <h3 class="signature first" id="doc-class_method">
272
+
273
+ + (<tt>Object</tt>) <strong>doc</strong>
274
+
275
+
276
+
277
+
278
+
279
+ </h3><table class="source_code">
280
+ <tr>
281
+ <td>
282
+ <pre class="lines">
283
+
284
+
285
+ 4
286
+ 5
287
+ 6</pre>
288
+ </td>
289
+ <td>
290
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 4</span>
291
+
292
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
293
+ <span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
294
+ <span class='kw'>end</span></pre>
295
+ </td>
296
+ </tr>
297
+ </table>
298
+ </div>
299
+
300
+ </div>
301
+
302
+ <div id="instance_method_details" class="method_details_list">
303
+ <h2>Instance Method Details</h2>
304
+
305
+
306
+ <div class="method_details first">
307
+ <h3 class="signature first" id="create-instance_method">
308
+
309
+ - (<tt>Object</tt>) <strong>create</strong>(params = { }, headers = { })
310
+
311
+
312
+
313
+
314
+
315
+ </h3><div class="docstring">
316
+ <div class="discussion">
317
+
318
+
319
+ </div>
320
+ </div>
321
+ <div class="tags">
322
+ <p class="tag_title">Parameters:</p>
323
+ <ul class="param">
324
+
325
+ <li>
326
+
327
+ <span class='name'>params</span>
328
+
329
+
330
+ <span class='type'>(<tt>Hash</tt>)</span>
331
+
332
+
333
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
334
+
335
+
336
+ &mdash;
337
+ <div class='inline'>
338
+ <p>a hash of params to be passed to the service</p>
339
+ </div>
340
+
341
+ </li>
342
+
343
+ <li>
344
+
345
+ <span class='name'>headers</span>
346
+
347
+
348
+ <span class='type'>(<tt>Hash</tt>)</span>
349
+
350
+
351
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
352
+
353
+
354
+ &mdash;
355
+ <div class='inline'>
356
+ <p>additional http headers</p>
357
+ </div>
358
+
359
+ </li>
360
+
361
+ </ul>
362
+
363
+
364
+
365
+
366
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
367
+ <ul class="option">
368
+
369
+ <li>
370
+ <span class="name">user</span>
371
+ <span class="type">(<tt>Hash</tt>)</span>
372
+ <span class="default">
373
+
374
+ </span>
375
+
376
+ &mdash; <div class='inline'>
377
+ <p>allowed keys are:</p>
378
+ <ul><li>
379
+ <p>admin [String] Is an admin account? ,</p>
380
+ </li><li>
381
+ <p>auth_source_id [Numeric],</p>
382
+ </li><li>
383
+ <p>firstname [String],</p>
384
+ </li><li>
385
+ <p>lastname [String],</p>
386
+ </li><li>
387
+ <p>login [String],</p>
388
+ </li><li>
389
+ <p>mail [String],</p>
390
+ </li><li>
391
+ <p>password [String],</p>
392
+ </li></ul>
393
+ </div>
394
+
395
+ </li>
396
+
397
+ </ul>
398
+
399
+
400
+
401
+
402
+
403
+ </div><table class="source_code">
404
+ <tr>
405
+ <td>
406
+ <pre class="lines">
407
+
408
+
409
+ 43
410
+ 44
411
+ 45
412
+ 46
413
+ 47</pre>
414
+ </td>
415
+ <td>
416
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 43</span>
417
+
418
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
419
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
420
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
421
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
422
+ <span class='kw'>end</span></pre>
423
+ </td>
424
+ </tr>
425
+ </table>
426
+ </div>
427
+
428
+ <div class="method_details ">
429
+ <h3 class="signature " id="destroy-instance_method">
430
+
431
+ - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
432
+
433
+
434
+
435
+
436
+
437
+ </h3><div class="docstring">
438
+ <div class="discussion">
439
+
440
+
441
+ </div>
442
+ </div>
443
+ <div class="tags">
444
+ <p class="tag_title">Parameters:</p>
445
+ <ul class="param">
446
+
447
+ <li>
448
+
449
+ <span class='name'>params</span>
450
+
451
+
452
+ <span class='type'>(<tt>Hash</tt>)</span>
453
+
454
+
455
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
456
+
457
+
458
+ &mdash;
459
+ <div class='inline'>
460
+ <p>a hash of params to be passed to the service</p>
461
+ </div>
462
+
463
+ </li>
464
+
465
+ <li>
466
+
467
+ <span class='name'>headers</span>
468
+
469
+
470
+ <span class='type'>(<tt>Hash</tt>)</span>
471
+
472
+
473
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
474
+
475
+
476
+ &mdash;
477
+ <div class='inline'>
478
+ <p>additional http headers</p>
479
+ </div>
480
+
481
+ </li>
482
+
483
+ </ul>
484
+
485
+
486
+
487
+
488
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
489
+ <ul class="option">
490
+
491
+ <li>
492
+ <span class="name">id</span>
493
+ <span class="type">(<tt>String</tt>)</span>
494
+ <span class="default">
495
+
496
+ </span>
497
+
498
+ </li>
499
+
500
+ </ul>
501
+
502
+
503
+
504
+
505
+
506
+ </div><table class="source_code">
507
+ <tr>
508
+ <td>
509
+ <pre class="lines">
510
+
511
+
512
+ 71
513
+ 72
514
+ 73
515
+ 74
516
+ 75</pre>
517
+ </td>
518
+ <td>
519
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 71</span>
520
+
521
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
522
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
523
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
524
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
525
+ <span class='kw'>end</span></pre>
526
+ </td>
527
+ </tr>
528
+ </table>
529
+ </div>
530
+
531
+ <div class="method_details ">
532
+ <h3 class="signature " id="index-instance_method">
533
+
534
+ - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
535
+
536
+
537
+
538
+
539
+
540
+ </h3><div class="docstring">
541
+ <div class="discussion">
542
+
543
+
544
+ </div>
545
+ </div>
546
+ <div class="tags">
547
+ <p class="tag_title">Parameters:</p>
548
+ <ul class="param">
549
+
550
+ <li>
551
+
552
+ <span class='name'>params</span>
553
+
554
+
555
+ <span class='type'>(<tt>Hash</tt>)</span>
556
+
557
+
558
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
559
+
560
+
561
+ &mdash;
562
+ <div class='inline'>
563
+ <p>a hash of params to be passed to the service</p>
564
+ </div>
565
+
566
+ </li>
567
+
568
+ <li>
569
+
570
+ <span class='name'>headers</span>
571
+
572
+
573
+ <span class='type'>(<tt>Hash</tt>)</span>
574
+
575
+
576
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
577
+
578
+
579
+ &mdash;
580
+ <div class='inline'>
581
+ <p>additional http headers</p>
582
+ </div>
583
+
584
+ </li>
585
+
586
+ </ul>
587
+
588
+
589
+
590
+
591
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
592
+ <ul class="option">
593
+
594
+ <li>
595
+ <span class="name">order</span>
596
+ <span class="type">(<tt>String</tt>)</span>
597
+ <span class="default">
598
+
599
+ </span>
600
+
601
+ &mdash; <div class='inline'>
602
+ <p>Sort results</p>
603
+ </div>
604
+
605
+ </li>
606
+
607
+ <li>
608
+ <span class="name">page</span>
609
+ <span class="type">(<tt>String</tt>)</span>
610
+ <span class="default">
611
+
612
+ </span>
613
+
614
+ &mdash; <div class='inline'>
615
+ <p>Paginate results</p>
616
+ </div>
617
+
618
+ </li>
619
+
620
+ <li>
621
+ <span class="name">per_page</span>
622
+ <span class="type">(<tt>String</tt>)</span>
623
+ <span class="default">
624
+
625
+ </span>
626
+
627
+ &mdash; <div class='inline'>
628
+ <p>Number of entries per request</p>
629
+ </div>
630
+
631
+ </li>
632
+
633
+ <li>
634
+ <span class="name">search</span>
635
+ <span class="type">(<tt>String</tt>)</span>
636
+ <span class="default">
637
+
638
+ </span>
639
+
640
+ &mdash; <div class='inline'>
641
+ <p>Filter results</p>
642
+ </div>
643
+
644
+ </li>
645
+
646
+ </ul>
647
+
648
+
649
+
650
+
651
+
652
+ </div><table class="source_code">
653
+ <tr>
654
+ <td>
655
+ <pre class="lines">
656
+
657
+
658
+ 15
659
+ 16
660
+ 17
661
+ 18
662
+ 19</pre>
663
+ </td>
664
+ <td>
665
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 15</span>
666
+
667
+ <span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
668
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
669
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
670
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
671
+ <span class='kw'>end</span></pre>
672
+ </td>
673
+ </tr>
674
+ </table>
675
+ </div>
676
+
677
+ <div class="method_details ">
678
+ <h3 class="signature " id="show-instance_method">
679
+
680
+ - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
681
+
682
+
683
+
684
+
685
+
686
+ </h3><div class="docstring">
687
+ <div class="discussion">
688
+
689
+
690
+ </div>
691
+ </div>
692
+ <div class="tags">
693
+ <p class="tag_title">Parameters:</p>
694
+ <ul class="param">
695
+
696
+ <li>
697
+
698
+ <span class='name'>params</span>
699
+
700
+
701
+ <span class='type'>(<tt>Hash</tt>)</span>
702
+
703
+
704
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
705
+
706
+
707
+ &mdash;
708
+ <div class='inline'>
709
+ <p>a hash of params to be passed to the service</p>
710
+ </div>
711
+
712
+ </li>
713
+
714
+ <li>
715
+
716
+ <span class='name'>headers</span>
717
+
718
+
719
+ <span class='type'>(<tt>Hash</tt>)</span>
720
+
721
+
722
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
723
+
724
+
725
+ &mdash;
726
+ <div class='inline'>
727
+ <p>additional http headers</p>
728
+ </div>
729
+
730
+ </li>
731
+
732
+ </ul>
733
+
734
+
735
+
736
+
737
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
738
+ <ul class="option">
739
+
740
+ <li>
741
+ <span class="name">id</span>
742
+ <span class="type">(<tt>String</tt>)</span>
743
+ <span class="default">
744
+
745
+ </span>
746
+
747
+ </li>
748
+
749
+ </ul>
750
+
751
+
752
+
753
+
754
+
755
+ </div><table class="source_code">
756
+ <tr>
757
+ <td>
758
+ <pre class="lines">
759
+
760
+
761
+ 25
762
+ 26
763
+ 27
764
+ 28
765
+ 29</pre>
766
+ </td>
767
+ <td>
768
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 25</span>
769
+
770
+ <span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
771
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
772
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
773
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
774
+ <span class='kw'>end</span></pre>
775
+ </td>
776
+ </tr>
777
+ </table>
778
+ </div>
779
+
780
+ <div class="method_details ">
781
+ <h3 class="signature " id="update-instance_method">
782
+
783
+ - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
784
+
785
+
786
+
787
+
788
+
789
+ </h3><div class="docstring">
790
+ <div class="discussion">
791
+
792
+
793
+ </div>
794
+ </div>
795
+ <div class="tags">
796
+ <p class="tag_title">Parameters:</p>
797
+ <ul class="param">
798
+
799
+ <li>
800
+
801
+ <span class='name'>params</span>
802
+
803
+
804
+ <span class='type'>(<tt>Hash</tt>)</span>
805
+
806
+
807
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
808
+
809
+
810
+ &mdash;
811
+ <div class='inline'>
812
+ <p>a hash of params to be passed to the service</p>
813
+ </div>
814
+
815
+ </li>
816
+
817
+ <li>
818
+
819
+ <span class='name'>headers</span>
820
+
821
+
822
+ <span class='type'>(<tt>Hash</tt>)</span>
823
+
824
+
825
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
826
+
827
+
828
+ &mdash;
829
+ <div class='inline'>
830
+ <p>additional http headers</p>
831
+ </div>
832
+
833
+ </li>
834
+
835
+ </ul>
836
+
837
+
838
+
839
+
840
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
841
+ <ul class="option">
842
+
843
+ <li>
844
+ <span class="name">id</span>
845
+ <span class="type">(<tt>String</tt>)</span>
846
+ <span class="default">
847
+
848
+ </span>
849
+
850
+ </li>
851
+
852
+ <li>
853
+ <span class="name">user</span>
854
+ <span class="type">(<tt>Hash</tt>)</span>
855
+ <span class="default">
856
+
857
+ </span>
858
+
859
+ &mdash; <div class='inline'>
860
+ <p>allowed keys are:</p>
861
+ <ul><li>
862
+ <p>admin [String] Is an admin account? ,</p>
863
+ </li><li>
864
+ <p>firstname [String, nil],</p>
865
+ </li><li>
866
+ <p>lastname [String, nil],</p>
867
+ </li><li>
868
+ <p>login [String],</p>
869
+ </li><li>
870
+ <p>mail [String],</p>
871
+ </li><li>
872
+ <p>password [String],</p>
873
+ </li></ul>
874
+ </div>
875
+
876
+ </li>
877
+
878
+ </ul>
879
+
880
+
881
+
882
+
883
+
884
+ </div><table class="source_code">
885
+ <tr>
886
+ <td>
887
+ <pre class="lines">
888
+
889
+
890
+ 61
891
+ 62
892
+ 63
893
+ 64
894
+ 65</pre>
895
+ </td>
896
+ <td>
897
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/user.rb', line 61</span>
898
+
899
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
900
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
901
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
902
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
903
+ <span class='kw'>end</span></pre>
904
+ </td>
905
+ </tr>
906
+ </table>
907
+ </div>
908
+
909
+ </div>
910
+
911
+ </div>
912
+
913
+ <div id="footer">
914
+ Generated on Mon Jan 21 15:44:34 2013 by
915
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
916
+ 0.8.3 (ruby-1.9.3).
917
+ </div>
918
+
919
+ </body>
920
+ </html>