katello_api 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +2 -0
- data/Gemfile +2 -0
- data/README.rdoc +0 -4
- data/doc/KatelloApi/Base.html +831 -0
- data/doc/KatelloApi/Generator/Base.html +671 -0
- data/doc/KatelloApi/Generator.html +115 -0
- data/doc/KatelloApi/Resources/ActivationKey.html +1757 -0
- data/doc/KatelloApi/Resources/Architecture.html +1007 -0
- data/doc/KatelloApi/Resources/Changeset.html +1413 -0
- data/doc/KatelloApi/Resources/ChangesetsContent.html +2674 -0
- data/doc/KatelloApi/Resources/ComputeResource.html +1067 -0
- data/doc/KatelloApi/Resources/ConfigTemplate.html +1361 -0
- data/doc/KatelloApi/Resources/ContentView.html +938 -0
- data/doc/KatelloApi/Resources/ContentViewDefinition.html +1629 -0
- data/doc/KatelloApi/Resources/Crl.html +367 -0
- data/doc/KatelloApi/Resources/Distribution.html +560 -0
- data/doc/KatelloApi/Resources/Distributor.html +1892 -0
- data/doc/KatelloApi/Resources/Domain.html +1066 -0
- data/doc/KatelloApi/Resources/Environment.html +1645 -0
- data/doc/KatelloApi/Resources/Erratum.html +632 -0
- data/doc/KatelloApi/Resources/GpgKey.html +1220 -0
- data/doc/KatelloApi/Resources/HardwareModel.html +1025 -0
- data/doc/KatelloApi/Resources/Organization.html +1062 -0
- data/doc/KatelloApi/Resources/Package.html +728 -0
- data/doc/KatelloApi/Resources/Permission.html +1021 -0
- data/doc/KatelloApi/Resources/Ping.html +625 -0
- data/doc/KatelloApi/Resources/Product.html +1845 -0
- data/doc/KatelloApi/Resources/Provider.html +2237 -0
- data/doc/KatelloApi/Resources/Repository.html +1976 -0
- data/doc/KatelloApi/Resources/RepositorySet.html +770 -0
- data/doc/KatelloApi/Resources/Role.html +1257 -0
- data/doc/KatelloApi/Resources/RoleLdapGroup.html +728 -0
- data/doc/KatelloApi/Resources/SmartProxy.html +1054 -0
- data/doc/KatelloApi/Resources/Statu.html +367 -0
- data/doc/KatelloApi/Resources/Subnet.html +1007 -0
- data/doc/KatelloApi/Resources/Subscription.html +1064 -0
- data/doc/KatelloApi/Resources/Sync.html +826 -0
- data/doc/KatelloApi/Resources/SyncPlan.html +1148 -0
- data/doc/KatelloApi/Resources/System.html +3576 -0
- data/doc/KatelloApi/Resources/SystemGroup.html +2006 -0
- data/doc/KatelloApi/Resources/SystemGroupErratum.html +602 -0
- data/doc/KatelloApi/Resources/SystemGroupPackage.html +826 -0
- data/doc/KatelloApi/Resources/SystemPackage.html +770 -0
- data/doc/KatelloApi/Resources/Task.html +546 -0
- data/doc/KatelloApi/Resources/Template.html +1573 -0
- data/doc/KatelloApi/Resources/TemplatesContent.html +2268 -0
- data/doc/KatelloApi/Resources/Uebercert.html +406 -0
- data/doc/KatelloApi/Resources/User.html +1846 -0
- data/doc/KatelloApi/Resources.html +117 -0
- data/doc/KatelloApi.html +365 -0
- data/doc/_index.html +539 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +338 -0
- data/doc/file.README.html +127 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +127 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +2548 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/katello_api/base.rb +61 -6
- data/lib/katello_api/documentation.json +1 -0
- data/lib/katello_api/resources/activation_key.rb +51 -48
- data/lib/katello_api/resources/architecture.rb +19 -24
- data/lib/katello_api/resources/changeset.rb +39 -37
- data/lib/katello_api/resources/changesets_content.rb +64 -57
- data/lib/katello_api/resources/compute_resource.rb +37 -42
- data/lib/katello_api/resources/config_template.rb +40 -44
- data/lib/katello_api/resources/content_view.rb +14 -17
- data/lib/katello_api/resources/content_view_definition.rb +34 -42
- data/lib/katello_api/resources/crl.rb +3 -4
- data/lib/katello_api/resources/distribution.rb +8 -8
- data/lib/katello_api/resources/distributor.rb +35 -37
- data/lib/katello_api/resources/domain.rb +28 -32
- data/lib/katello_api/resources/environment.rb +38 -44
- data/lib/katello_api/resources/erratum.rb +9 -8
- data/lib/katello_api/resources/gpg_key.rb +28 -33
- data/lib/katello_api/resources/hardware_model.rb +25 -30
- data/lib/katello_api/resources/organization.rb +24 -26
- data/lib/katello_api/resources/package.rb +9 -12
- data/lib/katello_api/resources/permission.rb +21 -19
- data/lib/katello_api/resources/ping.rb +9 -12
- data/lib/katello_api/resources/product.rb +34 -43
- data/lib/katello_api/resources/provider.rb +55 -66
- data/lib/katello_api/resources/repository.rb +44 -55
- data/lib/katello_api/resources/repository_set.rb +9 -12
- data/lib/katello_api/resources/role.rb +35 -33
- data/lib/katello_api/resources/role_ldap_group.rb +10 -12
- data/lib/katello_api/resources/smart_proxy.rb +24 -28
- data/lib/katello_api/resources/statu.rb +3 -4
- data/lib/katello_api/resources/subnet.rb +19 -24
- data/lib/katello_api/resources/subscription.rb +16 -21
- data/lib/katello_api/resources/sync.rb +9 -12
- data/lib/katello_api/resources/sync_plan.rb +28 -33
- data/lib/katello_api/resources/system.rb +81 -90
- data/lib/katello_api/resources/system_group.rb +47 -57
- data/lib/katello_api/resources/system_group_erratum.rb +6 -8
- data/lib/katello_api/resources/system_group_package.rb +15 -18
- data/lib/katello_api/resources/system_package.rb +12 -15
- data/lib/katello_api/resources/task.rb +6 -8
- data/lib/katello_api/resources/template.rb +39 -47
- data/lib/katello_api/resources/templates_content.rb +40 -52
- data/lib/katello_api/resources/uebercert.rb +4 -4
- data/lib/katello_api/resources/user.rb +47 -50
- data/lib/katello_api/version.rb +1 -1
- data/lib/katello_api.rb +0 -13
- metadata +68 -4
|
@@ -0,0 +1,1846 @@
|
|
|
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: KatelloApi::Resources::User
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
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> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../../KatelloApi.html" title="KatelloApi (module)">KatelloApi</a></span></span> » <span class='title'><span class='object_link'><a href="../Resources.html" title="KatelloApi::Resources (module)">Resources</a></span></span>
|
|
36
|
+
»
|
|
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: KatelloApi::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"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></li>
|
|
82
|
+
|
|
83
|
+
<li class="next">KatelloApi::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/katello_api/resources/user.rb</dd>
|
|
100
|
+
|
|
101
|
+
</dl>
|
|
102
|
+
<div class="clear"></div>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<h2>Constant Summary</h2>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<h2>Constant Summary</h2>
|
|
111
|
+
|
|
112
|
+
<h3 class="inherited">Constants inherited
|
|
113
|
+
from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
|
|
114
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#API_VERSION-constant" title="KatelloApi::Base::API_VERSION (constant)">Base::API_VERSION</a></span></p>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>Instance Attribute Summary</h2>
|
|
120
|
+
|
|
121
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
|
|
122
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#client-instance_method" title="KatelloApi::Base#client (method)">#client</a></span>, <span class='object_link'><a href="../Base.html#config-instance_method" title="KatelloApi::Base#config (method)">#config</a></span></p>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<h2>
|
|
127
|
+
Class Method Summary
|
|
128
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
129
|
+
</h2>
|
|
130
|
+
|
|
131
|
+
<ul class="summary">
|
|
132
|
+
|
|
133
|
+
<li class="public ">
|
|
134
|
+
<span class="summary_signature">
|
|
135
|
+
|
|
136
|
+
<a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
</span>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
151
|
+
|
|
152
|
+
</li>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
</ul>
|
|
156
|
+
|
|
157
|
+
<h2>
|
|
158
|
+
Instance Method Summary
|
|
159
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
160
|
+
</h2>
|
|
161
|
+
|
|
162
|
+
<ul class="summary">
|
|
163
|
+
|
|
164
|
+
<li class="public ">
|
|
165
|
+
<span class="summary_signature">
|
|
166
|
+
|
|
167
|
+
<a href="#add_role-instance_method" title="#add_role (instance method)">- (Array) <strong>add_role</strong>(params = {}, headers = {}) </a>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
</span>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
182
|
+
First item: parsed data; second item: raw body.
|
|
183
|
+
</p>
|
|
184
|
+
</div></span>
|
|
185
|
+
|
|
186
|
+
</li>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<li class="public ">
|
|
190
|
+
<span class="summary_signature">
|
|
191
|
+
|
|
192
|
+
<a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</span>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
207
|
+
First item: parsed data; second item: raw body.
|
|
208
|
+
</p>
|
|
209
|
+
</div></span>
|
|
210
|
+
|
|
211
|
+
</li>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<li class="public ">
|
|
215
|
+
<span class="summary_signature">
|
|
216
|
+
|
|
217
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
</span>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
232
|
+
First item: parsed data; second item: raw body.
|
|
233
|
+
</p>
|
|
234
|
+
</div></span>
|
|
235
|
+
|
|
236
|
+
</li>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<li class="public ">
|
|
240
|
+
<span class="summary_signature">
|
|
241
|
+
|
|
242
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
257
|
+
First item: parsed data; second item: raw body.
|
|
258
|
+
</p>
|
|
259
|
+
</div></span>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<li class="public ">
|
|
265
|
+
<span class="summary_signature">
|
|
266
|
+
|
|
267
|
+
<a href="#list_roles-instance_method" title="#list_roles (instance method)">- (Array) <strong>list_roles</strong>(params = {}, headers = {}) </a>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</span>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
282
|
+
First item: parsed data; second item: raw body.
|
|
283
|
+
</p>
|
|
284
|
+
</div></span>
|
|
285
|
+
|
|
286
|
+
</li>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<li class="public ">
|
|
290
|
+
<span class="summary_signature">
|
|
291
|
+
|
|
292
|
+
<a href="#remove_role-instance_method" title="#remove_role (instance method)">- (Array) <strong>remove_role</strong>(params = {}, headers = {}) </a>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
</span>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
307
|
+
First item: parsed data; second item: raw body.
|
|
308
|
+
</p>
|
|
309
|
+
</div></span>
|
|
310
|
+
|
|
311
|
+
</li>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
<li class="public ">
|
|
315
|
+
<span class="summary_signature">
|
|
316
|
+
|
|
317
|
+
<a href="#report-instance_method" title="#report (instance method)">- (Array) <strong>report</strong>(params = {}, headers = {}) </a>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
</span>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
332
|
+
First item: parsed data; second item: raw body.
|
|
333
|
+
</p>
|
|
334
|
+
</div></span>
|
|
335
|
+
|
|
336
|
+
</li>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<li class="public ">
|
|
340
|
+
<span class="summary_signature">
|
|
341
|
+
|
|
342
|
+
<a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
</span>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
357
|
+
First item: parsed data; second item: raw body.
|
|
358
|
+
</p>
|
|
359
|
+
</div></span>
|
|
360
|
+
|
|
361
|
+
</li>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
<li class="public ">
|
|
365
|
+
<span class="summary_signature">
|
|
366
|
+
|
|
367
|
+
<a href="#sync_ldap_roles-instance_method" title="#sync_ldap_roles (instance method)">- (Array) <strong>sync_ldap_roles</strong>(params = {}, headers = {}) </a>
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
</span>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
382
|
+
First item: parsed data; second item: raw body.
|
|
383
|
+
</p>
|
|
384
|
+
</div></span>
|
|
385
|
+
|
|
386
|
+
</li>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<li class="public ">
|
|
390
|
+
<span class="summary_signature">
|
|
391
|
+
|
|
392
|
+
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
</span>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
407
|
+
First item: parsed data; second item: raw body.
|
|
408
|
+
</p>
|
|
409
|
+
</div></span>
|
|
410
|
+
|
|
411
|
+
</li>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
</ul>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
|
|
427
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#http_call-instance_method" title="KatelloApi::Base#http_call (method)">#http_call</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Base.html#method_doc-class_method" title="KatelloApi::Base.method_doc (method)">method_doc</a></span>, <span class='object_link'><a href="../Base.html#perform_call-instance_method" title="KatelloApi::Base#perform_call (method)">#perform_call</a></span>, <span class='object_link'><a href="../Base.html#validate_params%21-instance_method" title="KatelloApi::Base#validate_params! (method)">#validate_params!</a></span>, <span class='object_link'><a href="../Base.html#validation_hash-class_method" title="KatelloApi::Base.validation_hash (method)">validation_hash</a></span></p>
|
|
428
|
+
<div id="constructor_details" class="method_details_list">
|
|
429
|
+
<h2>Constructor Details</h2>
|
|
430
|
+
|
|
431
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">KatelloApi::Base</a></span></p>
|
|
432
|
+
|
|
433
|
+
</div>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<div id="class_method_details" class="method_details_list">
|
|
437
|
+
<h2>Class Method Details</h2>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<div class="method_details first">
|
|
441
|
+
<h3 class="signature first" id="doc-class_method">
|
|
442
|
+
|
|
443
|
+
+ (<tt>Object</tt>) <strong>doc</strong>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</h3><table class="source_code">
|
|
450
|
+
<tr>
|
|
451
|
+
<td>
|
|
452
|
+
<pre class="lines">
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
4
|
|
456
|
+
5
|
|
457
|
+
6</pre>
|
|
458
|
+
</td>
|
|
459
|
+
<td>
|
|
460
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 4</span>
|
|
461
|
+
|
|
462
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
|
|
463
|
+
<span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_KatelloApi constant id'>KatelloApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>"users"</span><span class='rbrack token'>]</span>
|
|
464
|
+
<span class='rubyid_end end kw'>end</span>
|
|
465
|
+
</pre>
|
|
466
|
+
</td>
|
|
467
|
+
</tr>
|
|
468
|
+
</table>
|
|
469
|
+
</div>
|
|
470
|
+
|
|
471
|
+
</div>
|
|
472
|
+
|
|
473
|
+
<div id="instance_method_details" class="method_details_list">
|
|
474
|
+
<h2>Instance Method Details</h2>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
<div class="method_details first">
|
|
478
|
+
<h3 class="signature first" id="add_role-instance_method">
|
|
479
|
+
|
|
480
|
+
- (<tt>Array</tt>) <strong>add_role</strong>(params = {}, headers = {})
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</h3><div class="docstring">
|
|
487
|
+
<div class="discussion">
|
|
488
|
+
<p>
|
|
489
|
+
First item: parsed data; second item: raw body
|
|
490
|
+
</p>
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</div>
|
|
494
|
+
</div>
|
|
495
|
+
<div class="tags">
|
|
496
|
+
<p class="tag_title">Parameters:</p>
|
|
497
|
+
<ul class="param">
|
|
498
|
+
|
|
499
|
+
<li>
|
|
500
|
+
|
|
501
|
+
<span class='name'>params</span>
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
—
|
|
511
|
+
<div class='inline'><p>
|
|
512
|
+
a hash of params to be passed to the service
|
|
513
|
+
</p>
|
|
514
|
+
</div>
|
|
515
|
+
|
|
516
|
+
</li>
|
|
517
|
+
|
|
518
|
+
<li>
|
|
519
|
+
|
|
520
|
+
<span class='name'>headers</span>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
—
|
|
530
|
+
<div class='inline'><p>
|
|
531
|
+
additional http headers
|
|
532
|
+
</p>
|
|
533
|
+
</div>
|
|
534
|
+
|
|
535
|
+
</li>
|
|
536
|
+
|
|
537
|
+
</ul>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
543
|
+
<ul class="option">
|
|
544
|
+
|
|
545
|
+
<li>
|
|
546
|
+
<span class="name">role_id</span>
|
|
547
|
+
<span class="type">(<tt>Numeric</tt>)</span>
|
|
548
|
+
<span class="default">
|
|
549
|
+
|
|
550
|
+
</span>
|
|
551
|
+
|
|
552
|
+
</li>
|
|
553
|
+
|
|
554
|
+
<li>
|
|
555
|
+
<span class="name">user_id</span>
|
|
556
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
557
|
+
<span class="default">
|
|
558
|
+
|
|
559
|
+
</span>
|
|
560
|
+
|
|
561
|
+
— <div class='inline'><p>
|
|
562
|
+
Part of <tt>/api/users/:user_id/roles</tt> path
|
|
563
|
+
</p>
|
|
564
|
+
</div>
|
|
565
|
+
|
|
566
|
+
</li>
|
|
567
|
+
|
|
568
|
+
</ul>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
<p class="tag_title">Returns:</p>
|
|
574
|
+
<ul class="return">
|
|
575
|
+
|
|
576
|
+
<li>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'><p>
|
|
585
|
+
First item: parsed data; second item: raw body
|
|
586
|
+
</p>
|
|
587
|
+
</div>
|
|
588
|
+
|
|
589
|
+
</li>
|
|
590
|
+
|
|
591
|
+
</ul>
|
|
592
|
+
|
|
593
|
+
</div><table class="source_code">
|
|
594
|
+
<tr>
|
|
595
|
+
<td>
|
|
596
|
+
<pre class="lines">
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
86
|
|
600
|
+
87
|
|
601
|
+
88</pre>
|
|
602
|
+
</td>
|
|
603
|
+
<td>
|
|
604
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 86</span>
|
|
605
|
+
|
|
606
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_add_role identifier id'>add_role</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
607
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
608
|
+
<span class='rubyid_end end kw'>end</span>
|
|
609
|
+
</pre>
|
|
610
|
+
</td>
|
|
611
|
+
</tr>
|
|
612
|
+
</table>
|
|
613
|
+
</div>
|
|
614
|
+
|
|
615
|
+
<div class="method_details ">
|
|
616
|
+
<h3 class="signature " id="create-instance_method">
|
|
617
|
+
|
|
618
|
+
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
</h3><div class="docstring">
|
|
625
|
+
<div class="discussion">
|
|
626
|
+
<p>
|
|
627
|
+
First item: parsed data; second item: raw body
|
|
628
|
+
</p>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
</div>
|
|
632
|
+
</div>
|
|
633
|
+
<div class="tags">
|
|
634
|
+
<p class="tag_title">Parameters:</p>
|
|
635
|
+
<ul class="param">
|
|
636
|
+
|
|
637
|
+
<li>
|
|
638
|
+
|
|
639
|
+
<span class='name'>params</span>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
—
|
|
649
|
+
<div class='inline'><p>
|
|
650
|
+
a hash of params to be passed to the service
|
|
651
|
+
</p>
|
|
652
|
+
</div>
|
|
653
|
+
|
|
654
|
+
</li>
|
|
655
|
+
|
|
656
|
+
<li>
|
|
657
|
+
|
|
658
|
+
<span class='name'>headers</span>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
—
|
|
668
|
+
<div class='inline'><p>
|
|
669
|
+
additional http headers
|
|
670
|
+
</p>
|
|
671
|
+
</div>
|
|
672
|
+
|
|
673
|
+
</li>
|
|
674
|
+
|
|
675
|
+
</ul>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
681
|
+
<ul class="option">
|
|
682
|
+
|
|
683
|
+
<li>
|
|
684
|
+
<span class="name">default_environment_id</span>
|
|
685
|
+
<span class="type">(<tt>Numeric</tt>, <tt>nil</tt>)</span>
|
|
686
|
+
<span class="default">
|
|
687
|
+
|
|
688
|
+
</span>
|
|
689
|
+
|
|
690
|
+
</li>
|
|
691
|
+
|
|
692
|
+
<li>
|
|
693
|
+
<span class="name">disabled</span>
|
|
694
|
+
<span class="type">(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
695
|
+
<span class="default">
|
|
696
|
+
|
|
697
|
+
</span>
|
|
698
|
+
|
|
699
|
+
</li>
|
|
700
|
+
|
|
701
|
+
<li>
|
|
702
|
+
<span class="name">email</span>
|
|
703
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
704
|
+
<span class="default">
|
|
705
|
+
|
|
706
|
+
</span>
|
|
707
|
+
|
|
708
|
+
</li>
|
|
709
|
+
|
|
710
|
+
<li>
|
|
711
|
+
<span class="name">password</span>
|
|
712
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
713
|
+
<span class="default">
|
|
714
|
+
|
|
715
|
+
</span>
|
|
716
|
+
|
|
717
|
+
</li>
|
|
718
|
+
|
|
719
|
+
<li>
|
|
720
|
+
<span class="name">username</span>
|
|
721
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
722
|
+
<span class="default">
|
|
723
|
+
|
|
724
|
+
</span>
|
|
725
|
+
|
|
726
|
+
</li>
|
|
727
|
+
|
|
728
|
+
</ul>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
<p class="tag_title">Returns:</p>
|
|
734
|
+
<ul class="return">
|
|
735
|
+
|
|
736
|
+
<li>
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
—
|
|
744
|
+
<div class='inline'><p>
|
|
745
|
+
First item: parsed data; second item: raw body
|
|
746
|
+
</p>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
</li>
|
|
750
|
+
|
|
751
|
+
</ul>
|
|
752
|
+
|
|
753
|
+
</div><table class="source_code">
|
|
754
|
+
<tr>
|
|
755
|
+
<td>
|
|
756
|
+
<pre class="lines">
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
37
|
|
760
|
+
38
|
|
761
|
+
39</pre>
|
|
762
|
+
</td>
|
|
763
|
+
<td>
|
|
764
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 37</span>
|
|
765
|
+
|
|
766
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
767
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
768
|
+
<span class='rubyid_end end kw'>end</span>
|
|
769
|
+
</pre>
|
|
770
|
+
</td>
|
|
771
|
+
</tr>
|
|
772
|
+
</table>
|
|
773
|
+
</div>
|
|
774
|
+
|
|
775
|
+
<div class="method_details ">
|
|
776
|
+
<h3 class="signature " id="destroy-instance_method">
|
|
777
|
+
|
|
778
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
</h3><div class="docstring">
|
|
785
|
+
<div class="discussion">
|
|
786
|
+
<p>
|
|
787
|
+
First item: parsed data; second item: raw body
|
|
788
|
+
</p>
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
</div>
|
|
792
|
+
</div>
|
|
793
|
+
<div class="tags">
|
|
794
|
+
<p class="tag_title">Parameters:</p>
|
|
795
|
+
<ul class="param">
|
|
796
|
+
|
|
797
|
+
<li>
|
|
798
|
+
|
|
799
|
+
<span class='name'>params</span>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
—
|
|
809
|
+
<div class='inline'><p>
|
|
810
|
+
a hash of params to be passed to the service
|
|
811
|
+
</p>
|
|
812
|
+
</div>
|
|
813
|
+
|
|
814
|
+
</li>
|
|
815
|
+
|
|
816
|
+
<li>
|
|
817
|
+
|
|
818
|
+
<span class='name'>headers</span>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
—
|
|
828
|
+
<div class='inline'><p>
|
|
829
|
+
additional http headers
|
|
830
|
+
</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>Object</tt>)</span>
|
|
846
|
+
<span class="default">
|
|
847
|
+
|
|
848
|
+
</span>
|
|
849
|
+
|
|
850
|
+
— <div class='inline'><p>
|
|
851
|
+
Part of <tt>/api/users/:id</tt> path
|
|
852
|
+
</p>
|
|
853
|
+
</div>
|
|
854
|
+
|
|
855
|
+
</li>
|
|
856
|
+
|
|
857
|
+
</ul>
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
<p class="tag_title">Returns:</p>
|
|
863
|
+
<ul class="return">
|
|
864
|
+
|
|
865
|
+
<li>
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
—
|
|
873
|
+
<div class='inline'><p>
|
|
874
|
+
First item: parsed data; second item: raw body
|
|
875
|
+
</p>
|
|
876
|
+
</div>
|
|
877
|
+
|
|
878
|
+
</li>
|
|
879
|
+
|
|
880
|
+
</ul>
|
|
881
|
+
|
|
882
|
+
</div><table class="source_code">
|
|
883
|
+
<tr>
|
|
884
|
+
<td>
|
|
885
|
+
<pre class="lines">
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
59
|
|
889
|
+
60
|
|
890
|
+
61</pre>
|
|
891
|
+
</td>
|
|
892
|
+
<td>
|
|
893
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 59</span>
|
|
894
|
+
|
|
895
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
896
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
897
|
+
<span class='rubyid_end end kw'>end</span>
|
|
898
|
+
</pre>
|
|
899
|
+
</td>
|
|
900
|
+
</tr>
|
|
901
|
+
</table>
|
|
902
|
+
</div>
|
|
903
|
+
|
|
904
|
+
<div class="method_details ">
|
|
905
|
+
<h3 class="signature " id="index-instance_method">
|
|
906
|
+
|
|
907
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
</h3><div class="docstring">
|
|
914
|
+
<div class="discussion">
|
|
915
|
+
<p>
|
|
916
|
+
First item: parsed data; second item: raw body
|
|
917
|
+
</p>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
</div>
|
|
921
|
+
</div>
|
|
922
|
+
<div class="tags">
|
|
923
|
+
<p class="tag_title">Parameters:</p>
|
|
924
|
+
<ul class="param">
|
|
925
|
+
|
|
926
|
+
<li>
|
|
927
|
+
|
|
928
|
+
<span class='name'>params</span>
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
—
|
|
938
|
+
<div class='inline'><p>
|
|
939
|
+
a hash of params to be passed to the service
|
|
940
|
+
</p>
|
|
941
|
+
</div>
|
|
942
|
+
|
|
943
|
+
</li>
|
|
944
|
+
|
|
945
|
+
<li>
|
|
946
|
+
|
|
947
|
+
<span class='name'>headers</span>
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
—
|
|
957
|
+
<div class='inline'><p>
|
|
958
|
+
additional http headers
|
|
959
|
+
</p>
|
|
960
|
+
</div>
|
|
961
|
+
|
|
962
|
+
</li>
|
|
963
|
+
|
|
964
|
+
</ul>
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
970
|
+
<ul class="option">
|
|
971
|
+
|
|
972
|
+
<li>
|
|
973
|
+
<span class="name">disabled</span>
|
|
974
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
975
|
+
<span class="default">
|
|
976
|
+
|
|
977
|
+
</span>
|
|
978
|
+
|
|
979
|
+
— <div class='inline'><p>
|
|
980
|
+
filter by disabled flag
|
|
981
|
+
</p>
|
|
982
|
+
</div>
|
|
983
|
+
|
|
984
|
+
</li>
|
|
985
|
+
|
|
986
|
+
<li>
|
|
987
|
+
<span class="name">email</span>
|
|
988
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
989
|
+
<span class="default">
|
|
990
|
+
|
|
991
|
+
</span>
|
|
992
|
+
|
|
993
|
+
— <div class='inline'><p>
|
|
994
|
+
filter by email
|
|
995
|
+
</p>
|
|
996
|
+
</div>
|
|
997
|
+
|
|
998
|
+
</li>
|
|
999
|
+
|
|
1000
|
+
<li>
|
|
1001
|
+
<span class="name">username</span>
|
|
1002
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1003
|
+
<span class="default">
|
|
1004
|
+
|
|
1005
|
+
</span>
|
|
1006
|
+
|
|
1007
|
+
— <div class='inline'><p>
|
|
1008
|
+
filter by username
|
|
1009
|
+
</p>
|
|
1010
|
+
</div>
|
|
1011
|
+
|
|
1012
|
+
</li>
|
|
1013
|
+
|
|
1014
|
+
</ul>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
<p class="tag_title">Returns:</p>
|
|
1020
|
+
<ul class="return">
|
|
1021
|
+
|
|
1022
|
+
<li>
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
—
|
|
1030
|
+
<div class='inline'><p>
|
|
1031
|
+
First item: parsed data; second item: raw body
|
|
1032
|
+
</p>
|
|
1033
|
+
</div>
|
|
1034
|
+
|
|
1035
|
+
</li>
|
|
1036
|
+
|
|
1037
|
+
</ul>
|
|
1038
|
+
|
|
1039
|
+
</div><table class="source_code">
|
|
1040
|
+
<tr>
|
|
1041
|
+
<td>
|
|
1042
|
+
<pre class="lines">
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
15
|
|
1046
|
+
16
|
|
1047
|
+
17</pre>
|
|
1048
|
+
</td>
|
|
1049
|
+
<td>
|
|
1050
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 15</span>
|
|
1051
|
+
|
|
1052
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1053
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
1054
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1055
|
+
</pre>
|
|
1056
|
+
</td>
|
|
1057
|
+
</tr>
|
|
1058
|
+
</table>
|
|
1059
|
+
</div>
|
|
1060
|
+
|
|
1061
|
+
<div class="method_details ">
|
|
1062
|
+
<h3 class="signature " id="list_roles-instance_method">
|
|
1063
|
+
|
|
1064
|
+
- (<tt>Array</tt>) <strong>list_roles</strong>(params = {}, headers = {})
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
</h3><div class="docstring">
|
|
1071
|
+
<div class="discussion">
|
|
1072
|
+
<p>
|
|
1073
|
+
First item: parsed data; second item: raw body
|
|
1074
|
+
</p>
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
</div>
|
|
1078
|
+
</div>
|
|
1079
|
+
<div class="tags">
|
|
1080
|
+
<p class="tag_title">Parameters:</p>
|
|
1081
|
+
<ul class="param">
|
|
1082
|
+
|
|
1083
|
+
<li>
|
|
1084
|
+
|
|
1085
|
+
<span class='name'>params</span>
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
—
|
|
1095
|
+
<div class='inline'><p>
|
|
1096
|
+
a hash of params to be passed to the service
|
|
1097
|
+
</p>
|
|
1098
|
+
</div>
|
|
1099
|
+
|
|
1100
|
+
</li>
|
|
1101
|
+
|
|
1102
|
+
<li>
|
|
1103
|
+
|
|
1104
|
+
<span class='name'>headers</span>
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
—
|
|
1114
|
+
<div class='inline'><p>
|
|
1115
|
+
additional http headers
|
|
1116
|
+
</p>
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
</li>
|
|
1120
|
+
|
|
1121
|
+
</ul>
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1127
|
+
<ul class="option">
|
|
1128
|
+
|
|
1129
|
+
<li>
|
|
1130
|
+
<span class="name">user_id</span>
|
|
1131
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
1132
|
+
<span class="default">
|
|
1133
|
+
|
|
1134
|
+
</span>
|
|
1135
|
+
|
|
1136
|
+
— <div class='inline'><p>
|
|
1137
|
+
Part of <tt>/api/users/:user_id/roles</tt> path
|
|
1138
|
+
</p>
|
|
1139
|
+
</div>
|
|
1140
|
+
|
|
1141
|
+
</li>
|
|
1142
|
+
|
|
1143
|
+
</ul>
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
<p class="tag_title">Returns:</p>
|
|
1149
|
+
<ul class="return">
|
|
1150
|
+
|
|
1151
|
+
<li>
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
—
|
|
1159
|
+
<div class='inline'><p>
|
|
1160
|
+
First item: parsed data; second item: raw body
|
|
1161
|
+
</p>
|
|
1162
|
+
</div>
|
|
1163
|
+
|
|
1164
|
+
</li>
|
|
1165
|
+
|
|
1166
|
+
</ul>
|
|
1167
|
+
|
|
1168
|
+
</div><table class="source_code">
|
|
1169
|
+
<tr>
|
|
1170
|
+
<td>
|
|
1171
|
+
<pre class="lines">
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
68
|
|
1175
|
+
69
|
|
1176
|
+
70</pre>
|
|
1177
|
+
</td>
|
|
1178
|
+
<td>
|
|
1179
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 68</span>
|
|
1180
|
+
|
|
1181
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_list_roles identifier id'>list_roles</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1182
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
1183
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1184
|
+
</pre>
|
|
1185
|
+
</td>
|
|
1186
|
+
</tr>
|
|
1187
|
+
</table>
|
|
1188
|
+
</div>
|
|
1189
|
+
|
|
1190
|
+
<div class="method_details ">
|
|
1191
|
+
<h3 class="signature " id="remove_role-instance_method">
|
|
1192
|
+
|
|
1193
|
+
- (<tt>Array</tt>) <strong>remove_role</strong>(params = {}, headers = {})
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
</h3><div class="docstring">
|
|
1200
|
+
<div class="discussion">
|
|
1201
|
+
<p>
|
|
1202
|
+
First item: parsed data; second item: raw body
|
|
1203
|
+
</p>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
</div>
|
|
1207
|
+
</div>
|
|
1208
|
+
<div class="tags">
|
|
1209
|
+
<p class="tag_title">Parameters:</p>
|
|
1210
|
+
<ul class="param">
|
|
1211
|
+
|
|
1212
|
+
<li>
|
|
1213
|
+
|
|
1214
|
+
<span class='name'>params</span>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
—
|
|
1224
|
+
<div class='inline'><p>
|
|
1225
|
+
a hash of params to be passed to the service
|
|
1226
|
+
</p>
|
|
1227
|
+
</div>
|
|
1228
|
+
|
|
1229
|
+
</li>
|
|
1230
|
+
|
|
1231
|
+
<li>
|
|
1232
|
+
|
|
1233
|
+
<span class='name'>headers</span>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
—
|
|
1243
|
+
<div class='inline'><p>
|
|
1244
|
+
additional http headers
|
|
1245
|
+
</p>
|
|
1246
|
+
</div>
|
|
1247
|
+
|
|
1248
|
+
</li>
|
|
1249
|
+
|
|
1250
|
+
</ul>
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1256
|
+
<ul class="option">
|
|
1257
|
+
|
|
1258
|
+
<li>
|
|
1259
|
+
<span class="name">id</span>
|
|
1260
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
1261
|
+
<span class="default">
|
|
1262
|
+
|
|
1263
|
+
</span>
|
|
1264
|
+
|
|
1265
|
+
— <div class='inline'><p>
|
|
1266
|
+
Part of <tt>/api/users/:user_id/roles/:id</tt> path
|
|
1267
|
+
</p>
|
|
1268
|
+
</div>
|
|
1269
|
+
|
|
1270
|
+
</li>
|
|
1271
|
+
|
|
1272
|
+
<li>
|
|
1273
|
+
<span class="name">user_id</span>
|
|
1274
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
1275
|
+
<span class="default">
|
|
1276
|
+
|
|
1277
|
+
</span>
|
|
1278
|
+
|
|
1279
|
+
— <div class='inline'><p>
|
|
1280
|
+
Part of <tt>/api/users/:user_id/roles/:id</tt> path
|
|
1281
|
+
</p>
|
|
1282
|
+
</div>
|
|
1283
|
+
|
|
1284
|
+
</li>
|
|
1285
|
+
|
|
1286
|
+
</ul>
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
<p class="tag_title">Returns:</p>
|
|
1292
|
+
<ul class="return">
|
|
1293
|
+
|
|
1294
|
+
<li>
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
—
|
|
1302
|
+
<div class='inline'><p>
|
|
1303
|
+
First item: parsed data; second item: raw body
|
|
1304
|
+
</p>
|
|
1305
|
+
</div>
|
|
1306
|
+
|
|
1307
|
+
</li>
|
|
1308
|
+
|
|
1309
|
+
</ul>
|
|
1310
|
+
|
|
1311
|
+
</div><table class="source_code">
|
|
1312
|
+
<tr>
|
|
1313
|
+
<td>
|
|
1314
|
+
<pre class="lines">
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
96
|
|
1318
|
+
97
|
|
1319
|
+
98</pre>
|
|
1320
|
+
</td>
|
|
1321
|
+
<td>
|
|
1322
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 96</span>
|
|
1323
|
+
|
|
1324
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_remove_role identifier id'>remove_role</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1325
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
1326
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1327
|
+
</pre>
|
|
1328
|
+
</td>
|
|
1329
|
+
</tr>
|
|
1330
|
+
</table>
|
|
1331
|
+
</div>
|
|
1332
|
+
|
|
1333
|
+
<div class="method_details ">
|
|
1334
|
+
<h3 class="signature " id="report-instance_method">
|
|
1335
|
+
|
|
1336
|
+
- (<tt>Array</tt>) <strong>report</strong>(params = {}, headers = {})
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
</h3><div class="docstring">
|
|
1343
|
+
<div class="discussion">
|
|
1344
|
+
<p>
|
|
1345
|
+
First item: parsed data; second item: raw body
|
|
1346
|
+
</p>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
</div>
|
|
1350
|
+
</div>
|
|
1351
|
+
<div class="tags">
|
|
1352
|
+
<p class="tag_title">Parameters:</p>
|
|
1353
|
+
<ul class="param">
|
|
1354
|
+
|
|
1355
|
+
<li>
|
|
1356
|
+
|
|
1357
|
+
<span class='name'>params</span>
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
—
|
|
1367
|
+
<div class='inline'><p>
|
|
1368
|
+
a hash of params to be passed to the service
|
|
1369
|
+
</p>
|
|
1370
|
+
</div>
|
|
1371
|
+
|
|
1372
|
+
</li>
|
|
1373
|
+
|
|
1374
|
+
<li>
|
|
1375
|
+
|
|
1376
|
+
<span class='name'>headers</span>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
—
|
|
1386
|
+
<div class='inline'><p>
|
|
1387
|
+
additional http headers
|
|
1388
|
+
</p>
|
|
1389
|
+
</div>
|
|
1390
|
+
|
|
1391
|
+
</li>
|
|
1392
|
+
|
|
1393
|
+
</ul>
|
|
1394
|
+
|
|
1395
|
+
<p class="tag_title">Returns:</p>
|
|
1396
|
+
<ul class="return">
|
|
1397
|
+
|
|
1398
|
+
<li>
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
—
|
|
1406
|
+
<div class='inline'><p>
|
|
1407
|
+
First item: parsed data; second item: raw body
|
|
1408
|
+
</p>
|
|
1409
|
+
</div>
|
|
1410
|
+
|
|
1411
|
+
</li>
|
|
1412
|
+
|
|
1413
|
+
</ul>
|
|
1414
|
+
|
|
1415
|
+
</div><table class="source_code">
|
|
1416
|
+
<tr>
|
|
1417
|
+
<td>
|
|
1418
|
+
<pre class="lines">
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
104
|
|
1422
|
+
105
|
|
1423
|
+
106</pre>
|
|
1424
|
+
</td>
|
|
1425
|
+
<td>
|
|
1426
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 104</span>
|
|
1427
|
+
|
|
1428
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_report identifier id'>report</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1429
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
1430
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1431
|
+
</pre>
|
|
1432
|
+
</td>
|
|
1433
|
+
</tr>
|
|
1434
|
+
</table>
|
|
1435
|
+
</div>
|
|
1436
|
+
|
|
1437
|
+
<div class="method_details ">
|
|
1438
|
+
<h3 class="signature " id="show-instance_method">
|
|
1439
|
+
|
|
1440
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
</h3><div class="docstring">
|
|
1447
|
+
<div class="discussion">
|
|
1448
|
+
<p>
|
|
1449
|
+
First item: parsed data; second item: raw body
|
|
1450
|
+
</p>
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
</div>
|
|
1454
|
+
</div>
|
|
1455
|
+
<div class="tags">
|
|
1456
|
+
<p class="tag_title">Parameters:</p>
|
|
1457
|
+
<ul class="param">
|
|
1458
|
+
|
|
1459
|
+
<li>
|
|
1460
|
+
|
|
1461
|
+
<span class='name'>params</span>
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
—
|
|
1471
|
+
<div class='inline'><p>
|
|
1472
|
+
a hash of params to be passed to the service
|
|
1473
|
+
</p>
|
|
1474
|
+
</div>
|
|
1475
|
+
|
|
1476
|
+
</li>
|
|
1477
|
+
|
|
1478
|
+
<li>
|
|
1479
|
+
|
|
1480
|
+
<span class='name'>headers</span>
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
—
|
|
1490
|
+
<div class='inline'><p>
|
|
1491
|
+
additional http headers
|
|
1492
|
+
</p>
|
|
1493
|
+
</div>
|
|
1494
|
+
|
|
1495
|
+
</li>
|
|
1496
|
+
|
|
1497
|
+
</ul>
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1503
|
+
<ul class="option">
|
|
1504
|
+
|
|
1505
|
+
<li>
|
|
1506
|
+
<span class="name">id</span>
|
|
1507
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
1508
|
+
<span class="default">
|
|
1509
|
+
|
|
1510
|
+
</span>
|
|
1511
|
+
|
|
1512
|
+
— <div class='inline'><p>
|
|
1513
|
+
Part of <tt>/api/users/:id</tt> path
|
|
1514
|
+
</p>
|
|
1515
|
+
</div>
|
|
1516
|
+
|
|
1517
|
+
</li>
|
|
1518
|
+
|
|
1519
|
+
</ul>
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
<p class="tag_title">Returns:</p>
|
|
1525
|
+
<ul class="return">
|
|
1526
|
+
|
|
1527
|
+
<li>
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
—
|
|
1535
|
+
<div class='inline'><p>
|
|
1536
|
+
First item: parsed data; second item: raw body
|
|
1537
|
+
</p>
|
|
1538
|
+
</div>
|
|
1539
|
+
|
|
1540
|
+
</li>
|
|
1541
|
+
|
|
1542
|
+
</ul>
|
|
1543
|
+
|
|
1544
|
+
</div><table class="source_code">
|
|
1545
|
+
<tr>
|
|
1546
|
+
<td>
|
|
1547
|
+
<pre class="lines">
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
24
|
|
1551
|
+
25
|
|
1552
|
+
26</pre>
|
|
1553
|
+
</td>
|
|
1554
|
+
<td>
|
|
1555
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 24</span>
|
|
1556
|
+
|
|
1557
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1558
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
1559
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1560
|
+
</pre>
|
|
1561
|
+
</td>
|
|
1562
|
+
</tr>
|
|
1563
|
+
</table>
|
|
1564
|
+
</div>
|
|
1565
|
+
|
|
1566
|
+
<div class="method_details ">
|
|
1567
|
+
<h3 class="signature " id="sync_ldap_roles-instance_method">
|
|
1568
|
+
|
|
1569
|
+
- (<tt>Array</tt>) <strong>sync_ldap_roles</strong>(params = {}, headers = {})
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
</h3><div class="docstring">
|
|
1576
|
+
<div class="discussion">
|
|
1577
|
+
<p>
|
|
1578
|
+
First item: parsed data; second item: raw body
|
|
1579
|
+
</p>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
</div>
|
|
1583
|
+
</div>
|
|
1584
|
+
<div class="tags">
|
|
1585
|
+
<p class="tag_title">Parameters:</p>
|
|
1586
|
+
<ul class="param">
|
|
1587
|
+
|
|
1588
|
+
<li>
|
|
1589
|
+
|
|
1590
|
+
<span class='name'>params</span>
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
—
|
|
1600
|
+
<div class='inline'><p>
|
|
1601
|
+
a hash of params to be passed to the service
|
|
1602
|
+
</p>
|
|
1603
|
+
</div>
|
|
1604
|
+
|
|
1605
|
+
</li>
|
|
1606
|
+
|
|
1607
|
+
<li>
|
|
1608
|
+
|
|
1609
|
+
<span class='name'>headers</span>
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
—
|
|
1619
|
+
<div class='inline'><p>
|
|
1620
|
+
additional http headers
|
|
1621
|
+
</p>
|
|
1622
|
+
</div>
|
|
1623
|
+
|
|
1624
|
+
</li>
|
|
1625
|
+
|
|
1626
|
+
</ul>
|
|
1627
|
+
|
|
1628
|
+
<p class="tag_title">Returns:</p>
|
|
1629
|
+
<ul class="return">
|
|
1630
|
+
|
|
1631
|
+
<li>
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
—
|
|
1639
|
+
<div class='inline'><p>
|
|
1640
|
+
First item: parsed data; second item: raw body
|
|
1641
|
+
</p>
|
|
1642
|
+
</div>
|
|
1643
|
+
|
|
1644
|
+
</li>
|
|
1645
|
+
|
|
1646
|
+
</ul>
|
|
1647
|
+
|
|
1648
|
+
</div><table class="source_code">
|
|
1649
|
+
<tr>
|
|
1650
|
+
<td>
|
|
1651
|
+
<pre class="lines">
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
76
|
|
1655
|
+
77
|
|
1656
|
+
78</pre>
|
|
1657
|
+
</td>
|
|
1658
|
+
<td>
|
|
1659
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 76</span>
|
|
1660
|
+
|
|
1661
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_sync_ldap_roles identifier id'>sync_ldap_roles</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1662
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
1663
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1664
|
+
</pre>
|
|
1665
|
+
</td>
|
|
1666
|
+
</tr>
|
|
1667
|
+
</table>
|
|
1668
|
+
</div>
|
|
1669
|
+
|
|
1670
|
+
<div class="method_details ">
|
|
1671
|
+
<h3 class="signature " id="update-instance_method">
|
|
1672
|
+
|
|
1673
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
</h3><div class="docstring">
|
|
1680
|
+
<div class="discussion">
|
|
1681
|
+
<p>
|
|
1682
|
+
First item: parsed data; second item: raw body
|
|
1683
|
+
</p>
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
</div>
|
|
1687
|
+
</div>
|
|
1688
|
+
<div class="tags">
|
|
1689
|
+
<p class="tag_title">Parameters:</p>
|
|
1690
|
+
<ul class="param">
|
|
1691
|
+
|
|
1692
|
+
<li>
|
|
1693
|
+
|
|
1694
|
+
<span class='name'>params</span>
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
—
|
|
1704
|
+
<div class='inline'><p>
|
|
1705
|
+
a hash of params to be passed to the service
|
|
1706
|
+
</p>
|
|
1707
|
+
</div>
|
|
1708
|
+
|
|
1709
|
+
</li>
|
|
1710
|
+
|
|
1711
|
+
<li>
|
|
1712
|
+
|
|
1713
|
+
<span class='name'>headers</span>
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
—
|
|
1723
|
+
<div class='inline'><p>
|
|
1724
|
+
additional http headers
|
|
1725
|
+
</p>
|
|
1726
|
+
</div>
|
|
1727
|
+
|
|
1728
|
+
</li>
|
|
1729
|
+
|
|
1730
|
+
</ul>
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
|
1736
|
+
<ul class="option">
|
|
1737
|
+
|
|
1738
|
+
<li>
|
|
1739
|
+
<span class="name">id</span>
|
|
1740
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
1741
|
+
<span class="default">
|
|
1742
|
+
|
|
1743
|
+
</span>
|
|
1744
|
+
|
|
1745
|
+
— <div class='inline'><p>
|
|
1746
|
+
Part of <tt>/api/users/:id</tt> path
|
|
1747
|
+
</p>
|
|
1748
|
+
</div>
|
|
1749
|
+
|
|
1750
|
+
</li>
|
|
1751
|
+
|
|
1752
|
+
<li>
|
|
1753
|
+
<span class="name">default_environment_id</span>
|
|
1754
|
+
<span class="type">(<tt>Numeric</tt>, <tt>nil</tt>)</span>
|
|
1755
|
+
<span class="default">
|
|
1756
|
+
|
|
1757
|
+
</span>
|
|
1758
|
+
|
|
1759
|
+
</li>
|
|
1760
|
+
|
|
1761
|
+
<li>
|
|
1762
|
+
<span class="name">disabled</span>
|
|
1763
|
+
<span class="type">(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
1764
|
+
<span class="default">
|
|
1765
|
+
|
|
1766
|
+
</span>
|
|
1767
|
+
|
|
1768
|
+
</li>
|
|
1769
|
+
|
|
1770
|
+
<li>
|
|
1771
|
+
<span class="name">email</span>
|
|
1772
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1773
|
+
<span class="default">
|
|
1774
|
+
|
|
1775
|
+
</span>
|
|
1776
|
+
|
|
1777
|
+
</li>
|
|
1778
|
+
|
|
1779
|
+
<li>
|
|
1780
|
+
<span class="name">password</span>
|
|
1781
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
1782
|
+
<span class="default">
|
|
1783
|
+
|
|
1784
|
+
</span>
|
|
1785
|
+
|
|
1786
|
+
</li>
|
|
1787
|
+
|
|
1788
|
+
</ul>
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
<p class="tag_title">Returns:</p>
|
|
1794
|
+
<ul class="return">
|
|
1795
|
+
|
|
1796
|
+
<li>
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
—
|
|
1804
|
+
<div class='inline'><p>
|
|
1805
|
+
First item: parsed data; second item: raw body
|
|
1806
|
+
</p>
|
|
1807
|
+
</div>
|
|
1808
|
+
|
|
1809
|
+
</li>
|
|
1810
|
+
|
|
1811
|
+
</ul>
|
|
1812
|
+
|
|
1813
|
+
</div><table class="source_code">
|
|
1814
|
+
<tr>
|
|
1815
|
+
<td>
|
|
1816
|
+
<pre class="lines">
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
50
|
|
1820
|
+
51
|
|
1821
|
+
52</pre>
|
|
1822
|
+
</td>
|
|
1823
|
+
<td>
|
|
1824
|
+
<pre class="code"><span class="info file"># File 'lib/katello_api/resources/user.rb', line 50</span>
|
|
1825
|
+
|
|
1826
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
1827
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
|
1828
|
+
<span class='rubyid_end end kw'>end</span>
|
|
1829
|
+
</pre>
|
|
1830
|
+
</td>
|
|
1831
|
+
</tr>
|
|
1832
|
+
</table>
|
|
1833
|
+
</div>
|
|
1834
|
+
|
|
1835
|
+
</div>
|
|
1836
|
+
|
|
1837
|
+
</div>
|
|
1838
|
+
|
|
1839
|
+
<div id="footer">
|
|
1840
|
+
Generated on Mon Mar 18 14:17:41 2013 by
|
|
1841
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1842
|
+
0.8.5.2 (ruby-1.8.7).
|
|
1843
|
+
</div>
|
|
1844
|
+
|
|
1845
|
+
</body>
|
|
1846
|
+
</html>
|