dashboard-api 1.0.0 → 1.0.1
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.
- checksums.yaml +4 -4
- data/.codeclimate.yml +34 -0
- data/.gitignore +5 -4
- data/.travis.yml +20 -0
- data/Gemfile +9 -5
- data/Gemfile.lock +63 -31
- data/README.md +134 -138
- data/Rakefile +9 -7
- data/dashboard-api.gemspec +28 -28
- data/doc/Admins.html +603 -603
- data/doc/Clients.html +276 -276
- data/doc/DashboardAPI.html +603 -603
- data/doc/DashboardAPIVersion.html +159 -159
- data/doc/Devices.html +879 -879
- data/doc/Networks.html +1382 -1382
- data/doc/Organizations.html +1477 -1477
- data/doc/Phones.html +641 -641
- data/doc/SAML.html +758 -758
- data/doc/SSIDs.html +523 -523
- data/doc/Switchports.html +526 -526
- data/doc/Templates.html +378 -378
- data/doc/VLANs.html +762 -762
- data/doc/_index.html +235 -235
- data/doc/class_list.html +51 -51
- data/doc/css/full_list.css +58 -58
- data/doc/css/style.css +481 -481
- data/doc/file.README.html +248 -248
- data/doc/file_list.html +56 -56
- data/doc/frames.html +17 -17
- data/doc/index.html +248 -248
- data/doc/js/app.js +243 -243
- data/doc/js/full_list.js +216 -216
- data/doc/js/jquery.js +3 -3
- data/doc/method_list.html +523 -523
- data/doc/top-level-namespace.html +113 -113
- data/lib/admins.rb +37 -37
- data/lib/clients.rb +12 -12
- data/lib/dashboard-api.rb +82 -83
- data/lib/dashboard-api/version.rb +6 -6
- data/lib/devices.rb +57 -57
- data/lib/networks.rb +108 -108
- data/lib/organizations.rb +110 -115
- data/lib/phones.rb +40 -40
- data/lib/saml.rb +47 -47
- data/lib/ssids.rb +33 -33
- data/lib/switchports.rb +33 -33
- data/lib/templates.rb +18 -18
- data/lib/vlans.rb +49 -49
- metadata +7 -5
data/doc/SAML.html
CHANGED
|
@@ -1,759 +1,759 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html>
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>
|
|
7
|
-
Module: SAML
|
|
8
|
-
|
|
9
|
-
— Documentation by YARD 0.9.5
|
|
10
|
-
|
|
11
|
-
</title>
|
|
12
|
-
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
-
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
-
|
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
|
18
|
-
pathId = "SAML";
|
|
19
|
-
relpath = '';
|
|
20
|
-
</script>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
-
|
|
25
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
</head>
|
|
29
|
-
<body>
|
|
30
|
-
<div class="nav_wrap">
|
|
31
|
-
<iframe id="nav" src="class_list.html"></iframe>
|
|
32
|
-
<div id="resizer"></div>
|
|
33
|
-
</div>
|
|
34
|
-
|
|
35
|
-
<div id="main" tabindex="-1">
|
|
36
|
-
<div id="header">
|
|
37
|
-
<div id="menu">
|
|
38
|
-
|
|
39
|
-
<a href="_index.html">Index (S)</a> »
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
<span class="title">SAML</span>
|
|
43
|
-
|
|
44
|
-
</div>
|
|
45
|
-
|
|
46
|
-
<div id="search">
|
|
47
|
-
|
|
48
|
-
<a class="full_list_link" id="class_list_link"
|
|
49
|
-
href="class_list.html">
|
|
50
|
-
|
|
51
|
-
<svg width="24" height="24">
|
|
52
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
-
</svg>
|
|
56
|
-
</a>
|
|
57
|
-
|
|
58
|
-
</div>
|
|
59
|
-
<div class="clear"></div>
|
|
60
|
-
</div>
|
|
61
|
-
|
|
62
|
-
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
63
|
-
|
|
64
|
-
<div id="content"><h1>Module: SAML
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
</h1>
|
|
69
|
-
<div class="box_info">
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
<dl>
|
|
80
|
-
<dt>Included in:</dt>
|
|
81
|
-
<dd><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span></dd>
|
|
82
|
-
</dl>
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
<dl>
|
|
87
|
-
<dt>Defined in:</dt>
|
|
88
|
-
<dd>lib/saml.rb</dd>
|
|
89
|
-
</dl>
|
|
90
|
-
|
|
91
|
-
</div>
|
|
92
|
-
|
|
93
|
-
<h2>Overview</h2><div class="docstring">
|
|
94
|
-
<div class="discussion">
|
|
95
|
-
|
|
96
|
-
<p>SAML section of the Meraki Dashboard API</p>
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
</div>
|
|
100
|
-
</div>
|
|
101
|
-
<div class="tags">
|
|
102
|
-
|
|
103
|
-
<p class="tag_title">Author:</p>
|
|
104
|
-
<ul class="author">
|
|
105
|
-
|
|
106
|
-
<li>
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
<div class='inline'>
|
|
113
|
-
<p>Joe Letizia</p>
|
|
114
|
-
</div>
|
|
115
|
-
|
|
116
|
-
</li>
|
|
117
|
-
|
|
118
|
-
</ul>
|
|
119
|
-
|
|
120
|
-
</div>
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
<h2>
|
|
129
|
-
Instance Method Summary
|
|
130
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
131
|
-
</h2>
|
|
132
|
-
|
|
133
|
-
<ul class="summary">
|
|
134
|
-
|
|
135
|
-
<li class="public ">
|
|
136
|
-
<span class="summary_signature">
|
|
137
|
-
|
|
138
|
-
<a href="#create_saml_role-instance_method" title="#create_saml_role (instance method)">#<strong>create_saml_role</strong>(org_id, options) ⇒ Hash </a>
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
</span>
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
<span class="summary_desc"><div class='inline'>
|
|
153
|
-
<p>Create a new SAML role on an organization.</p>
|
|
154
|
-
</div></span>
|
|
155
|
-
|
|
156
|
-
</li>
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
<li class="public ">
|
|
160
|
-
<span class="summary_signature">
|
|
161
|
-
|
|
162
|
-
<a href="#list_saml_roles-instance_method" title="#list_saml_roles (instance method)">#<strong>list_saml_roles</strong>(org_id) ⇒ Array </a>
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
</span>
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
<span class="summary_desc"><div class='inline'>
|
|
177
|
-
<p>List all SAML roles defined on an organization.</p>
|
|
178
|
-
</div></span>
|
|
179
|
-
|
|
180
|
-
</li>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
<li class="public ">
|
|
184
|
-
<span class="summary_signature">
|
|
185
|
-
|
|
186
|
-
<a href="#remove_saml_role-instance_method" title="#remove_saml_role (instance method)">#<strong>remove_saml_role</strong>(org_id, saml_id) ⇒ Integer </a>
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
</span>
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
<span class="summary_desc"><div class='inline'>
|
|
201
|
-
<p>Remove a single SAML role.</p>
|
|
202
|
-
</div></span>
|
|
203
|
-
|
|
204
|
-
</li>
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
<li class="public ">
|
|
208
|
-
<span class="summary_signature">
|
|
209
|
-
|
|
210
|
-
<a href="#return_saml_role-instance_method" title="#return_saml_role (instance method)">#<strong>return_saml_role</strong>(org_id, saml_id) ⇒ Hash </a>
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
</span>
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
<span class="summary_desc"><div class='inline'>
|
|
225
|
-
<p>Return a single SAML role.</p>
|
|
226
|
-
</div></span>
|
|
227
|
-
|
|
228
|
-
</li>
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
<li class="public ">
|
|
232
|
-
<span class="summary_signature">
|
|
233
|
-
|
|
234
|
-
<a href="#update_saml_role-instance_method" title="#update_saml_role (instance method)">#<strong>update_saml_role</strong>(org_id, saml_id, options) ⇒ Hahs </a>
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
</span>
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
<span class="summary_desc"><div class='inline'>
|
|
249
|
-
<p>Update an existing SAML role on an organization.</p>
|
|
250
|
-
</div></span>
|
|
251
|
-
|
|
252
|
-
</li>
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
</ul>
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
<div id="instance_method_details" class="method_details_list">
|
|
261
|
-
<h2>Instance Method Details</h2>
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
<div class="method_details first">
|
|
265
|
-
<h3 class="signature first" id="create_saml_role-instance_method">
|
|
266
|
-
|
|
267
|
-
#<strong>create_saml_role</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
</h3><div class="docstring">
|
|
274
|
-
<div class="discussion">
|
|
275
|
-
|
|
276
|
-
<p>Create a new SAML role on an organization</p>
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
</div>
|
|
280
|
-
</div>
|
|
281
|
-
<div class="tags">
|
|
282
|
-
<p class="tag_title">Parameters:</p>
|
|
283
|
-
<ul class="param">
|
|
284
|
-
|
|
285
|
-
<li>
|
|
286
|
-
|
|
287
|
-
<span class='name'>org_id</span>
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
—
|
|
295
|
-
<div class='inline'>
|
|
296
|
-
<p>organization ID you want to create the SAML roles on</p>
|
|
297
|
-
</div>
|
|
298
|
-
|
|
299
|
-
</li>
|
|
300
|
-
|
|
301
|
-
<li>
|
|
302
|
-
|
|
303
|
-
<span class='name'>options</span>
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
—
|
|
311
|
-
<div class='inline'>
|
|
312
|
-
<p>an options hash containing the attributes for the SAML role. Can include
|
|
313
|
-
role, orgAccess, tags, and networks. Refer to the Meraki Dashboard API for
|
|
314
|
-
more information on these tags</p>
|
|
315
|
-
</div>
|
|
316
|
-
|
|
317
|
-
</li>
|
|
318
|
-
|
|
319
|
-
</ul>
|
|
320
|
-
|
|
321
|
-
<p class="tag_title">Returns:</p>
|
|
322
|
-
<ul class="return">
|
|
323
|
-
|
|
324
|
-
<li>
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
—
|
|
332
|
-
<div class='inline'>
|
|
333
|
-
<p>returns the newly created SAML role</p>
|
|
334
|
-
</div>
|
|
335
|
-
|
|
336
|
-
</li>
|
|
337
|
-
|
|
338
|
-
</ul>
|
|
339
|
-
|
|
340
|
-
</div><table class="source_code">
|
|
341
|
-
<tr>
|
|
342
|
-
<td>
|
|
343
|
-
<pre class="lines">
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
16
|
|
347
|
-
17
|
|
348
|
-
18
|
|
349
|
-
19</pre>
|
|
350
|
-
</td>
|
|
351
|
-
<td>
|
|
352
|
-
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 16</span>
|
|
353
|
-
|
|
354
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create_saml_role'>create_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
355
|
-
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
|
|
356
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
357
|
-
<span class='kw'>end</span></pre>
|
|
358
|
-
</td>
|
|
359
|
-
</tr>
|
|
360
|
-
</table>
|
|
361
|
-
</div>
|
|
362
|
-
|
|
363
|
-
<div class="method_details ">
|
|
364
|
-
<h3 class="signature " id="list_saml_roles-instance_method">
|
|
365
|
-
|
|
366
|
-
#<strong>list_saml_roles</strong>(org_id) ⇒ <tt>Array</tt>
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
</h3><div class="docstring">
|
|
373
|
-
<div class="discussion">
|
|
374
|
-
|
|
375
|
-
<p>List all SAML roles defined on an organization</p>
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
</div>
|
|
379
|
-
</div>
|
|
380
|
-
<div class="tags">
|
|
381
|
-
<p class="tag_title">Parameters:</p>
|
|
382
|
-
<ul class="param">
|
|
383
|
-
|
|
384
|
-
<li>
|
|
385
|
-
|
|
386
|
-
<span class='name'>org_id</span>
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
—
|
|
394
|
-
<div class='inline'>
|
|
395
|
-
<p>organization ID you want the SAML roles from</p>
|
|
396
|
-
</div>
|
|
397
|
-
|
|
398
|
-
</li>
|
|
399
|
-
|
|
400
|
-
</ul>
|
|
401
|
-
|
|
402
|
-
<p class="tag_title">Returns:</p>
|
|
403
|
-
<ul class="return">
|
|
404
|
-
|
|
405
|
-
<li>
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
—
|
|
413
|
-
<div class='inline'>
|
|
414
|
-
<p>an array of hashes containing each SAML role and it's attributes</p>
|
|
415
|
-
</div>
|
|
416
|
-
|
|
417
|
-
</li>
|
|
418
|
-
|
|
419
|
-
</ul>
|
|
420
|
-
|
|
421
|
-
</div><table class="source_code">
|
|
422
|
-
<tr>
|
|
423
|
-
<td>
|
|
424
|
-
<pre class="lines">
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
7
|
|
428
|
-
8
|
|
429
|
-
9</pre>
|
|
430
|
-
</td>
|
|
431
|
-
<td>
|
|
432
|
-
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 7</span>
|
|
433
|
-
|
|
434
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list_saml_roles'>list_saml_roles</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
435
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
436
|
-
<span class='kw'>end</span></pre>
|
|
437
|
-
</td>
|
|
438
|
-
</tr>
|
|
439
|
-
</table>
|
|
440
|
-
</div>
|
|
441
|
-
|
|
442
|
-
<div class="method_details ">
|
|
443
|
-
<h3 class="signature " id="remove_saml_role-instance_method">
|
|
444
|
-
|
|
445
|
-
#<strong>remove_saml_role</strong>(org_id, saml_id) ⇒ <tt>Integer</tt>
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
</h3><div class="docstring">
|
|
452
|
-
<div class="discussion">
|
|
453
|
-
|
|
454
|
-
<p>Remove a single SAML role</p>
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
</div>
|
|
458
|
-
</div>
|
|
459
|
-
<div class="tags">
|
|
460
|
-
<p class="tag_title">Parameters:</p>
|
|
461
|
-
<ul class="param">
|
|
462
|
-
|
|
463
|
-
<li>
|
|
464
|
-
|
|
465
|
-
<span class='name'>org_id</span>
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
—
|
|
473
|
-
<div class='inline'>
|
|
474
|
-
<p>organization ID you want to remove the SAML roles on</p>
|
|
475
|
-
</div>
|
|
476
|
-
|
|
477
|
-
</li>
|
|
478
|
-
|
|
479
|
-
<li>
|
|
480
|
-
|
|
481
|
-
<span class='name'>saml_id</span>
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
—
|
|
489
|
-
<div class='inline'>
|
|
490
|
-
<p>the ID of the SAML role that you want to remove</p>
|
|
491
|
-
</div>
|
|
492
|
-
|
|
493
|
-
</li>
|
|
494
|
-
|
|
495
|
-
</ul>
|
|
496
|
-
|
|
497
|
-
<p class="tag_title">Returns:</p>
|
|
498
|
-
<ul class="return">
|
|
499
|
-
|
|
500
|
-
<li>
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
—
|
|
508
|
-
<div class='inline'>
|
|
509
|
-
<p>HTTP Code</p>
|
|
510
|
-
</div>
|
|
511
|
-
|
|
512
|
-
</li>
|
|
513
|
-
|
|
514
|
-
</ul>
|
|
515
|
-
|
|
516
|
-
</div><table class="source_code">
|
|
517
|
-
<tr>
|
|
518
|
-
<td>
|
|
519
|
-
<pre class="lines">
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
44
|
|
523
|
-
45
|
|
524
|
-
46</pre>
|
|
525
|
-
</td>
|
|
526
|
-
<td>
|
|
527
|
-
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 44</span>
|
|
528
|
-
|
|
529
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_remove_saml_role'>remove_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_saml_id'>saml_id</span><span class='rparen'>)</span>
|
|
530
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_saml_id'>saml_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
531
|
-
<span class='kw'>end</span></pre>
|
|
532
|
-
</td>
|
|
533
|
-
</tr>
|
|
534
|
-
</table>
|
|
535
|
-
</div>
|
|
536
|
-
|
|
537
|
-
<div class="method_details ">
|
|
538
|
-
<h3 class="signature " id="return_saml_role-instance_method">
|
|
539
|
-
|
|
540
|
-
#<strong>return_saml_role</strong>(org_id, saml_id) ⇒ <tt>Hash</tt>
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
</h3><div class="docstring">
|
|
547
|
-
<div class="discussion">
|
|
548
|
-
|
|
549
|
-
<p>Return a single SAML role</p>
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
</div>
|
|
553
|
-
</div>
|
|
554
|
-
<div class="tags">
|
|
555
|
-
<p class="tag_title">Parameters:</p>
|
|
556
|
-
<ul class="param">
|
|
557
|
-
|
|
558
|
-
<li>
|
|
559
|
-
|
|
560
|
-
<span class='name'>org_id</span>
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
—
|
|
568
|
-
<div class='inline'>
|
|
569
|
-
<p>organization ID you want to return the SAML roles on</p>
|
|
570
|
-
</div>
|
|
571
|
-
|
|
572
|
-
</li>
|
|
573
|
-
|
|
574
|
-
<li>
|
|
575
|
-
|
|
576
|
-
<span class='name'>saml_id</span>
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
—
|
|
584
|
-
<div class='inline'>
|
|
585
|
-
<p>the ID of the SAML role that you want to return</p>
|
|
586
|
-
</div>
|
|
587
|
-
|
|
588
|
-
</li>
|
|
589
|
-
|
|
590
|
-
</ul>
|
|
591
|
-
|
|
592
|
-
<p class="tag_title">Returns:</p>
|
|
593
|
-
<ul class="return">
|
|
594
|
-
|
|
595
|
-
<li>
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
—
|
|
603
|
-
<div class='inline'>
|
|
604
|
-
<p>returns the request SAML role</p>
|
|
605
|
-
</div>
|
|
606
|
-
|
|
607
|
-
</li>
|
|
608
|
-
|
|
609
|
-
</ul>
|
|
610
|
-
|
|
611
|
-
</div><table class="source_code">
|
|
612
|
-
<tr>
|
|
613
|
-
<td>
|
|
614
|
-
<pre class="lines">
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
36
|
|
618
|
-
37
|
|
619
|
-
38</pre>
|
|
620
|
-
</td>
|
|
621
|
-
<td>
|
|
622
|
-
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 36</span>
|
|
623
|
-
|
|
624
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_return_saml_role'>return_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_saml_id'>saml_id</span><span class='rparen'>)</span>
|
|
625
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_saml_id'>saml_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
626
|
-
<span class='kw'>end</span></pre>
|
|
627
|
-
</td>
|
|
628
|
-
</tr>
|
|
629
|
-
</table>
|
|
630
|
-
</div>
|
|
631
|
-
|
|
632
|
-
<div class="method_details ">
|
|
633
|
-
<h3 class="signature " id="update_saml_role-instance_method">
|
|
634
|
-
|
|
635
|
-
#<strong>update_saml_role</strong>(org_id, saml_id, options) ⇒ <tt>Hahs</tt>
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
</h3><div class="docstring">
|
|
642
|
-
<div class="discussion">
|
|
643
|
-
|
|
644
|
-
<p>Update an existing SAML role on an organization</p>
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
</div>
|
|
648
|
-
</div>
|
|
649
|
-
<div class="tags">
|
|
650
|
-
<p class="tag_title">Parameters:</p>
|
|
651
|
-
<ul class="param">
|
|
652
|
-
|
|
653
|
-
<li>
|
|
654
|
-
|
|
655
|
-
<span class='name'>org_id</span>
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
—
|
|
663
|
-
<div class='inline'>
|
|
664
|
-
<p>organization ID you want to update the SAML roles on</p>
|
|
665
|
-
</div>
|
|
666
|
-
|
|
667
|
-
</li>
|
|
668
|
-
|
|
669
|
-
<li>
|
|
670
|
-
|
|
671
|
-
<span class='name'>saml_id</span>
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
—
|
|
679
|
-
<div class='inline'>
|
|
680
|
-
<p>the ID of the SAML role that you want to update</p>
|
|
681
|
-
</div>
|
|
682
|
-
|
|
683
|
-
</li>
|
|
684
|
-
|
|
685
|
-
<li>
|
|
686
|
-
|
|
687
|
-
<span class='name'>options</span>
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
—
|
|
695
|
-
<div class='inline'>
|
|
696
|
-
<p>an options hash containing the attributes for the SAML role. Can include
|
|
697
|
-
role, orgAccess, tags, and networks. Refer to the Meraki Dashboard API for
|
|
698
|
-
more information on these tags</p>
|
|
699
|
-
</div>
|
|
700
|
-
|
|
701
|
-
</li>
|
|
702
|
-
|
|
703
|
-
</ul>
|
|
704
|
-
|
|
705
|
-
<p class="tag_title">Returns:</p>
|
|
706
|
-
<ul class="return">
|
|
707
|
-
|
|
708
|
-
<li>
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
<span class='type'>(<tt>Hahs</tt>)</span>
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
—
|
|
716
|
-
<div class='inline'>
|
|
717
|
-
<p>returns the updated SAML role</p>
|
|
718
|
-
</div>
|
|
719
|
-
|
|
720
|
-
</li>
|
|
721
|
-
|
|
722
|
-
</ul>
|
|
723
|
-
|
|
724
|
-
</div><table class="source_code">
|
|
725
|
-
<tr>
|
|
726
|
-
<td>
|
|
727
|
-
<pre class="lines">
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
27
|
|
731
|
-
28
|
|
732
|
-
29
|
|
733
|
-
30</pre>
|
|
734
|
-
</td>
|
|
735
|
-
<td>
|
|
736
|
-
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 27</span>
|
|
737
|
-
|
|
738
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_saml_role'>update_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_saml_id'>saml_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
739
|
-
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
|
|
740
|
-
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_saml_id'>saml_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
741
|
-
<span class='kw'>end</span></pre>
|
|
742
|
-
</td>
|
|
743
|
-
</tr>
|
|
744
|
-
</table>
|
|
745
|
-
</div>
|
|
746
|
-
|
|
747
|
-
</div>
|
|
748
|
-
|
|
749
|
-
</div>
|
|
750
|
-
|
|
751
|
-
<div id="footer">
|
|
752
|
-
Generated on Thu Nov 17 22:15:39 2016 by
|
|
753
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
754
|
-
0.9.5 (ruby-2.3.0).
|
|
755
|
-
</div>
|
|
756
|
-
|
|
757
|
-
</div>
|
|
758
|
-
</body>
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: SAML
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.5
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "SAML";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (S)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">SAML</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame" src="class_list.html"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><h1>Module: SAML
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</h1>
|
|
69
|
+
<div class="box_info">
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<dl>
|
|
80
|
+
<dt>Included in:</dt>
|
|
81
|
+
<dd><span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span></dd>
|
|
82
|
+
</dl>
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
<dl>
|
|
87
|
+
<dt>Defined in:</dt>
|
|
88
|
+
<dd>lib/saml.rb</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
|
94
|
+
<div class="discussion">
|
|
95
|
+
|
|
96
|
+
<p>SAML section of the Meraki Dashboard API</p>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</div>
|
|
100
|
+
</div>
|
|
101
|
+
<div class="tags">
|
|
102
|
+
|
|
103
|
+
<p class="tag_title">Author:</p>
|
|
104
|
+
<ul class="author">
|
|
105
|
+
|
|
106
|
+
<li>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<div class='inline'>
|
|
113
|
+
<p>Joe Letizia</p>
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
</li>
|
|
117
|
+
|
|
118
|
+
</ul>
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<h2>
|
|
129
|
+
Instance Method Summary
|
|
130
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
131
|
+
</h2>
|
|
132
|
+
|
|
133
|
+
<ul class="summary">
|
|
134
|
+
|
|
135
|
+
<li class="public ">
|
|
136
|
+
<span class="summary_signature">
|
|
137
|
+
|
|
138
|
+
<a href="#create_saml_role-instance_method" title="#create_saml_role (instance method)">#<strong>create_saml_role</strong>(org_id, options) ⇒ Hash </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<span class="summary_desc"><div class='inline'>
|
|
153
|
+
<p>Create a new SAML role on an organization.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#list_saml_roles-instance_method" title="#list_saml_roles (instance method)">#<strong>list_saml_roles</strong>(org_id) ⇒ Array </a>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</span>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="summary_desc"><div class='inline'>
|
|
177
|
+
<p>List all SAML roles defined on an organization.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#remove_saml_role-instance_method" title="#remove_saml_role (instance method)">#<strong>remove_saml_role</strong>(org_id, saml_id) ⇒ Integer </a>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="summary_desc"><div class='inline'>
|
|
201
|
+
<p>Remove a single SAML role.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#return_saml_role-instance_method" title="#return_saml_role (instance method)">#<strong>return_saml_role</strong>(org_id, saml_id) ⇒ Hash </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
|
225
|
+
<p>Return a single SAML role.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#update_saml_role-instance_method" title="#update_saml_role (instance method)">#<strong>update_saml_role</strong>(org_id, saml_id, options) ⇒ Hahs </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Update an existing SAML role on an organization.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</ul>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<div id="instance_method_details" class="method_details_list">
|
|
261
|
+
<h2>Instance Method Details</h2>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<div class="method_details first">
|
|
265
|
+
<h3 class="signature first" id="create_saml_role-instance_method">
|
|
266
|
+
|
|
267
|
+
#<strong>create_saml_role</strong>(org_id, options) ⇒ <tt>Hash</tt>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
</h3><div class="docstring">
|
|
274
|
+
<div class="discussion">
|
|
275
|
+
|
|
276
|
+
<p>Create a new SAML role on an organization</p>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
</div>
|
|
281
|
+
<div class="tags">
|
|
282
|
+
<p class="tag_title">Parameters:</p>
|
|
283
|
+
<ul class="param">
|
|
284
|
+
|
|
285
|
+
<li>
|
|
286
|
+
|
|
287
|
+
<span class='name'>org_id</span>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
—
|
|
295
|
+
<div class='inline'>
|
|
296
|
+
<p>organization ID you want to create the SAML roles on</p>
|
|
297
|
+
</div>
|
|
298
|
+
|
|
299
|
+
</li>
|
|
300
|
+
|
|
301
|
+
<li>
|
|
302
|
+
|
|
303
|
+
<span class='name'>options</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
—
|
|
311
|
+
<div class='inline'>
|
|
312
|
+
<p>an options hash containing the attributes for the SAML role. Can include
|
|
313
|
+
role, orgAccess, tags, and networks. Refer to the Meraki Dashboard API for
|
|
314
|
+
more information on these tags</p>
|
|
315
|
+
</div>
|
|
316
|
+
|
|
317
|
+
</li>
|
|
318
|
+
|
|
319
|
+
</ul>
|
|
320
|
+
|
|
321
|
+
<p class="tag_title">Returns:</p>
|
|
322
|
+
<ul class="return">
|
|
323
|
+
|
|
324
|
+
<li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
—
|
|
332
|
+
<div class='inline'>
|
|
333
|
+
<p>returns the newly created SAML role</p>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
</li>
|
|
337
|
+
|
|
338
|
+
</ul>
|
|
339
|
+
|
|
340
|
+
</div><table class="source_code">
|
|
341
|
+
<tr>
|
|
342
|
+
<td>
|
|
343
|
+
<pre class="lines">
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
16
|
|
347
|
+
17
|
|
348
|
+
18
|
|
349
|
+
19</pre>
|
|
350
|
+
</td>
|
|
351
|
+
<td>
|
|
352
|
+
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 16</span>
|
|
353
|
+
|
|
354
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_saml_role'>create_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
355
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
|
|
356
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
357
|
+
<span class='kw'>end</span></pre>
|
|
358
|
+
</td>
|
|
359
|
+
</tr>
|
|
360
|
+
</table>
|
|
361
|
+
</div>
|
|
362
|
+
|
|
363
|
+
<div class="method_details ">
|
|
364
|
+
<h3 class="signature " id="list_saml_roles-instance_method">
|
|
365
|
+
|
|
366
|
+
#<strong>list_saml_roles</strong>(org_id) ⇒ <tt>Array</tt>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
</h3><div class="docstring">
|
|
373
|
+
<div class="discussion">
|
|
374
|
+
|
|
375
|
+
<p>List all SAML roles defined on an organization</p>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</div>
|
|
379
|
+
</div>
|
|
380
|
+
<div class="tags">
|
|
381
|
+
<p class="tag_title">Parameters:</p>
|
|
382
|
+
<ul class="param">
|
|
383
|
+
|
|
384
|
+
<li>
|
|
385
|
+
|
|
386
|
+
<span class='name'>org_id</span>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
—
|
|
394
|
+
<div class='inline'>
|
|
395
|
+
<p>organization ID you want the SAML roles from</p>
|
|
396
|
+
</div>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
</ul>
|
|
401
|
+
|
|
402
|
+
<p class="tag_title">Returns:</p>
|
|
403
|
+
<ul class="return">
|
|
404
|
+
|
|
405
|
+
<li>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
—
|
|
413
|
+
<div class='inline'>
|
|
414
|
+
<p>an array of hashes containing each SAML role and it's attributes</p>
|
|
415
|
+
</div>
|
|
416
|
+
|
|
417
|
+
</li>
|
|
418
|
+
|
|
419
|
+
</ul>
|
|
420
|
+
|
|
421
|
+
</div><table class="source_code">
|
|
422
|
+
<tr>
|
|
423
|
+
<td>
|
|
424
|
+
<pre class="lines">
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
7
|
|
428
|
+
8
|
|
429
|
+
9</pre>
|
|
430
|
+
</td>
|
|
431
|
+
<td>
|
|
432
|
+
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 7</span>
|
|
433
|
+
|
|
434
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_saml_roles'>list_saml_roles</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
435
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
436
|
+
<span class='kw'>end</span></pre>
|
|
437
|
+
</td>
|
|
438
|
+
</tr>
|
|
439
|
+
</table>
|
|
440
|
+
</div>
|
|
441
|
+
|
|
442
|
+
<div class="method_details ">
|
|
443
|
+
<h3 class="signature " id="remove_saml_role-instance_method">
|
|
444
|
+
|
|
445
|
+
#<strong>remove_saml_role</strong>(org_id, saml_id) ⇒ <tt>Integer</tt>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</h3><div class="docstring">
|
|
452
|
+
<div class="discussion">
|
|
453
|
+
|
|
454
|
+
<p>Remove a single SAML role</p>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
</div>
|
|
458
|
+
</div>
|
|
459
|
+
<div class="tags">
|
|
460
|
+
<p class="tag_title">Parameters:</p>
|
|
461
|
+
<ul class="param">
|
|
462
|
+
|
|
463
|
+
<li>
|
|
464
|
+
|
|
465
|
+
<span class='name'>org_id</span>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
—
|
|
473
|
+
<div class='inline'>
|
|
474
|
+
<p>organization ID you want to remove the SAML roles on</p>
|
|
475
|
+
</div>
|
|
476
|
+
|
|
477
|
+
</li>
|
|
478
|
+
|
|
479
|
+
<li>
|
|
480
|
+
|
|
481
|
+
<span class='name'>saml_id</span>
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
—
|
|
489
|
+
<div class='inline'>
|
|
490
|
+
<p>the ID of the SAML role that you want to remove</p>
|
|
491
|
+
</div>
|
|
492
|
+
|
|
493
|
+
</li>
|
|
494
|
+
|
|
495
|
+
</ul>
|
|
496
|
+
|
|
497
|
+
<p class="tag_title">Returns:</p>
|
|
498
|
+
<ul class="return">
|
|
499
|
+
|
|
500
|
+
<li>
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
—
|
|
508
|
+
<div class='inline'>
|
|
509
|
+
<p>HTTP Code</p>
|
|
510
|
+
</div>
|
|
511
|
+
|
|
512
|
+
</li>
|
|
513
|
+
|
|
514
|
+
</ul>
|
|
515
|
+
|
|
516
|
+
</div><table class="source_code">
|
|
517
|
+
<tr>
|
|
518
|
+
<td>
|
|
519
|
+
<pre class="lines">
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
44
|
|
523
|
+
45
|
|
524
|
+
46</pre>
|
|
525
|
+
</td>
|
|
526
|
+
<td>
|
|
527
|
+
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 44</span>
|
|
528
|
+
|
|
529
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_saml_role'>remove_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_saml_id'>saml_id</span><span class='rparen'>)</span>
|
|
530
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_saml_id'>saml_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
531
|
+
<span class='kw'>end</span></pre>
|
|
532
|
+
</td>
|
|
533
|
+
</tr>
|
|
534
|
+
</table>
|
|
535
|
+
</div>
|
|
536
|
+
|
|
537
|
+
<div class="method_details ">
|
|
538
|
+
<h3 class="signature " id="return_saml_role-instance_method">
|
|
539
|
+
|
|
540
|
+
#<strong>return_saml_role</strong>(org_id, saml_id) ⇒ <tt>Hash</tt>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
</h3><div class="docstring">
|
|
547
|
+
<div class="discussion">
|
|
548
|
+
|
|
549
|
+
<p>Return a single SAML role</p>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</div>
|
|
553
|
+
</div>
|
|
554
|
+
<div class="tags">
|
|
555
|
+
<p class="tag_title">Parameters:</p>
|
|
556
|
+
<ul class="param">
|
|
557
|
+
|
|
558
|
+
<li>
|
|
559
|
+
|
|
560
|
+
<span class='name'>org_id</span>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
—
|
|
568
|
+
<div class='inline'>
|
|
569
|
+
<p>organization ID you want to return the SAML roles on</p>
|
|
570
|
+
</div>
|
|
571
|
+
|
|
572
|
+
</li>
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
|
|
576
|
+
<span class='name'>saml_id</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>the ID of the SAML role that you want to return</p>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
</li>
|
|
589
|
+
|
|
590
|
+
</ul>
|
|
591
|
+
|
|
592
|
+
<p class="tag_title">Returns:</p>
|
|
593
|
+
<ul class="return">
|
|
594
|
+
|
|
595
|
+
<li>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
—
|
|
603
|
+
<div class='inline'>
|
|
604
|
+
<p>returns the request SAML role</p>
|
|
605
|
+
</div>
|
|
606
|
+
|
|
607
|
+
</li>
|
|
608
|
+
|
|
609
|
+
</ul>
|
|
610
|
+
|
|
611
|
+
</div><table class="source_code">
|
|
612
|
+
<tr>
|
|
613
|
+
<td>
|
|
614
|
+
<pre class="lines">
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
36
|
|
618
|
+
37
|
|
619
|
+
38</pre>
|
|
620
|
+
</td>
|
|
621
|
+
<td>
|
|
622
|
+
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 36</span>
|
|
623
|
+
|
|
624
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_return_saml_role'>return_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_saml_id'>saml_id</span><span class='rparen'>)</span>
|
|
625
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_saml_id'>saml_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
626
|
+
<span class='kw'>end</span></pre>
|
|
627
|
+
</td>
|
|
628
|
+
</tr>
|
|
629
|
+
</table>
|
|
630
|
+
</div>
|
|
631
|
+
|
|
632
|
+
<div class="method_details ">
|
|
633
|
+
<h3 class="signature " id="update_saml_role-instance_method">
|
|
634
|
+
|
|
635
|
+
#<strong>update_saml_role</strong>(org_id, saml_id, options) ⇒ <tt>Hahs</tt>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
</h3><div class="docstring">
|
|
642
|
+
<div class="discussion">
|
|
643
|
+
|
|
644
|
+
<p>Update an existing SAML role on an organization</p>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
</div>
|
|
648
|
+
</div>
|
|
649
|
+
<div class="tags">
|
|
650
|
+
<p class="tag_title">Parameters:</p>
|
|
651
|
+
<ul class="param">
|
|
652
|
+
|
|
653
|
+
<li>
|
|
654
|
+
|
|
655
|
+
<span class='name'>org_id</span>
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
—
|
|
663
|
+
<div class='inline'>
|
|
664
|
+
<p>organization ID you want to update the SAML roles on</p>
|
|
665
|
+
</div>
|
|
666
|
+
|
|
667
|
+
</li>
|
|
668
|
+
|
|
669
|
+
<li>
|
|
670
|
+
|
|
671
|
+
<span class='name'>saml_id</span>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
—
|
|
679
|
+
<div class='inline'>
|
|
680
|
+
<p>the ID of the SAML role that you want to update</p>
|
|
681
|
+
</div>
|
|
682
|
+
|
|
683
|
+
</li>
|
|
684
|
+
|
|
685
|
+
<li>
|
|
686
|
+
|
|
687
|
+
<span class='name'>options</span>
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
—
|
|
695
|
+
<div class='inline'>
|
|
696
|
+
<p>an options hash containing the attributes for the SAML role. Can include
|
|
697
|
+
role, orgAccess, tags, and networks. Refer to the Meraki Dashboard API for
|
|
698
|
+
more information on these tags</p>
|
|
699
|
+
</div>
|
|
700
|
+
|
|
701
|
+
</li>
|
|
702
|
+
|
|
703
|
+
</ul>
|
|
704
|
+
|
|
705
|
+
<p class="tag_title">Returns:</p>
|
|
706
|
+
<ul class="return">
|
|
707
|
+
|
|
708
|
+
<li>
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
<span class='type'>(<tt>Hahs</tt>)</span>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
—
|
|
716
|
+
<div class='inline'>
|
|
717
|
+
<p>returns the updated SAML role</p>
|
|
718
|
+
</div>
|
|
719
|
+
|
|
720
|
+
</li>
|
|
721
|
+
|
|
722
|
+
</ul>
|
|
723
|
+
|
|
724
|
+
</div><table class="source_code">
|
|
725
|
+
<tr>
|
|
726
|
+
<td>
|
|
727
|
+
<pre class="lines">
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
27
|
|
731
|
+
28
|
|
732
|
+
29
|
|
733
|
+
30</pre>
|
|
734
|
+
</td>
|
|
735
|
+
<td>
|
|
736
|
+
<pre class="code"><span class="info file"># File 'lib/saml.rb', line 27</span>
|
|
737
|
+
|
|
738
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_saml_role'>update_saml_role</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_saml_id'>saml_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
739
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_options'>options</span><span class='rbrace'>}</span>
|
|
740
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_api_call'>make_api_call</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/organizations/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_org_id'>org_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/samlRoles/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_saml_id'>saml_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
741
|
+
<span class='kw'>end</span></pre>
|
|
742
|
+
</td>
|
|
743
|
+
</tr>
|
|
744
|
+
</table>
|
|
745
|
+
</div>
|
|
746
|
+
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
</div>
|
|
750
|
+
|
|
751
|
+
<div id="footer">
|
|
752
|
+
Generated on Thu Nov 17 22:15:39 2016 by
|
|
753
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
754
|
+
0.9.5 (ruby-2.3.0).
|
|
755
|
+
</div>
|
|
756
|
+
|
|
757
|
+
</div>
|
|
758
|
+
</body>
|
|
759
759
|
</html>
|