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/Rakefile
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
require 'rake/testtask'
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
require 'rake/testtask'
|
|
2
|
+
|
|
3
|
+
# set default so travis can build properly
|
|
4
|
+
task :default => :test
|
|
5
|
+
|
|
6
|
+
Rake::TestTask.new do |t|
|
|
7
|
+
t.test_files = FileList['test/test_*.rb']
|
|
8
|
+
t.warning = false
|
|
9
|
+
end
|
data/dashboard-api.gemspec
CHANGED
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
lib = File.expand_path('../lib', __FILE__)
|
|
2
|
-
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
3
|
-
|
|
4
|
-
require 'dashboard-api/version'
|
|
5
|
-
|
|
6
|
-
Gem::Specification.new do |s|
|
|
7
|
-
s.name = 'dashboard-api'
|
|
8
|
-
s.version = DashboardAPIVersion::VERSION
|
|
9
|
-
s.authors = ['Joe Letizia']
|
|
10
|
-
s.email = ['letiziajm@gmail.com']
|
|
11
|
-
|
|
12
|
-
s.summary = %q{A Ruby implementation of the Meraki Dashboard API}
|
|
13
|
-
s.description = %q{A Ruby implementation of the Meraki Dashboard API. It allows you to interact and provision the Meraki Dashboard via their RESTful API}
|
|
14
|
-
s.homepage = "https://github.com/jletizia/dashboardapi"
|
|
15
|
-
|
|
16
|
-
s.files = `git ls-files -z`.split("\x0").reject do |f|
|
|
17
|
-
f.match(%r{^(test|spec|features)/})
|
|
18
|
-
end
|
|
19
|
-
|
|
20
|
-
s.require_paths = ['lib']
|
|
21
|
-
s.add_development_dependency "rake", "~> 10.0"
|
|
22
|
-
s.add_development_dependency "minitest", "~> 5.0"
|
|
23
|
-
s.add_development_dependency "yard", "~> 0.9.
|
|
24
|
-
s.add_development_dependency "vcr", ">= 3.0.3"
|
|
25
|
-
s.add_development_dependency "webmock", ">= 2.1.0"
|
|
26
|
-
|
|
27
|
-
s.add_runtime_dependency "httparty", "~> 0.14.0"
|
|
28
|
-
end
|
|
1
|
+
lib = File.expand_path('../lib', __FILE__)
|
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
3
|
+
|
|
4
|
+
require 'dashboard-api/version'
|
|
5
|
+
|
|
6
|
+
Gem::Specification.new do |s|
|
|
7
|
+
s.name = 'dashboard-api'
|
|
8
|
+
s.version = DashboardAPIVersion::VERSION
|
|
9
|
+
s.authors = ['Joe Letizia']
|
|
10
|
+
s.email = ['letiziajm@gmail.com']
|
|
11
|
+
|
|
12
|
+
s.summary = %q{A Ruby implementation of the Meraki Dashboard API}
|
|
13
|
+
s.description = %q{A Ruby implementation of the Meraki Dashboard API. It allows you to interact and provision the Meraki Dashboard via their RESTful API}
|
|
14
|
+
s.homepage = "https://github.com/jletizia/dashboardapi"
|
|
15
|
+
|
|
16
|
+
s.files = `git ls-files -z`.split("\x0").reject do |f|
|
|
17
|
+
f.match(%r{^(test|spec|features)/})
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
s.require_paths = ['lib']
|
|
21
|
+
s.add_development_dependency "rake", "~> 10.0"
|
|
22
|
+
s.add_development_dependency "minitest", "~> 5.0"
|
|
23
|
+
s.add_development_dependency "yard", "~> 0.9.11"
|
|
24
|
+
s.add_development_dependency "vcr", ">= 3.0.3"
|
|
25
|
+
s.add_development_dependency "webmock", ">= 2.1.0"
|
|
26
|
+
|
|
27
|
+
s.add_runtime_dependency "httparty", "~> 0.14.0"
|
|
28
|
+
end
|
data/doc/Admins.html
CHANGED
|
@@ -1,604 +1,604 @@
|
|
|
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: Admins
|
|
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 = "Admins";
|
|
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 (A)</a> »
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
<span class="title">Admins</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: Admins
|
|
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/admins.rb</dd>
|
|
89
|
-
</dl>
|
|
90
|
-
|
|
91
|
-
</div>
|
|
92
|
-
|
|
93
|
-
<h2>Overview</h2><div class="docstring">
|
|
94
|
-
<div class="discussion">
|
|
95
|
-
|
|
96
|
-
<p>Admins 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="#add_admin-instance_method" title="#add_admin (instance method)">#<strong>add_admin</strong>(org_id, options) ⇒ Object </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>Add an admin to a specific org.</p>
|
|
154
|
-
</div></span>
|
|
155
|
-
|
|
156
|
-
</li>
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
<li class="public ">
|
|
160
|
-
<span class="summary_signature">
|
|
161
|
-
|
|
162
|
-
<a href="#list_admins-instance_method" title="#list_admins (instance method)">#<strong>list_admins</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 of the administrators for a given org.</p>
|
|
178
|
-
</div></span>
|
|
179
|
-
|
|
180
|
-
</li>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
<li class="public ">
|
|
184
|
-
<span class="summary_signature">
|
|
185
|
-
|
|
186
|
-
<a href="#revoke_admin-instance_method" title="#revoke_admin (instance method)">#<strong>revoke_admin</strong>(org_id, admin_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>Revoke an administrator for a specific org.</p>
|
|
202
|
-
</div></span>
|
|
203
|
-
|
|
204
|
-
</li>
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
<li class="public ">
|
|
208
|
-
<span class="summary_signature">
|
|
209
|
-
|
|
210
|
-
<a href="#update_admin-instance_method" title="#update_admin (instance method)">#<strong>update_admin</strong>(org_id, admin_id, options) ⇒ Object </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>Update an administrator for a specific org.</p>
|
|
226
|
-
</div></span>
|
|
227
|
-
|
|
228
|
-
</li>
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
</ul>
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
<div id="instance_method_details" class="method_details_list">
|
|
237
|
-
<h2>Instance Method Details</h2>
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
<div class="method_details first">
|
|
241
|
-
<h3 class="signature first" id="add_admin-instance_method">
|
|
242
|
-
|
|
243
|
-
#<strong>add_admin</strong>(org_id, options) ⇒ <tt>Object</tt>
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
</h3><div class="docstring">
|
|
250
|
-
<div class="discussion">
|
|
251
|
-
|
|
252
|
-
<p>Add an admin to a specific org</p>
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
</div>
|
|
256
|
-
</div>
|
|
257
|
-
<div class="tags">
|
|
258
|
-
<p class="tag_title">Parameters:</p>
|
|
259
|
-
<ul class="param">
|
|
260
|
-
|
|
261
|
-
<li>
|
|
262
|
-
|
|
263
|
-
<span class='name'>org_id</span>
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
—
|
|
271
|
-
<div class='inline'>
|
|
272
|
-
<p>organization ID you want to add an administrator to</p>
|
|
273
|
-
</div>
|
|
274
|
-
|
|
275
|
-
</li>
|
|
276
|
-
|
|
277
|
-
<li>
|
|
278
|
-
|
|
279
|
-
<span class='name'>options</span>
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
—
|
|
287
|
-
<div class='inline'>
|
|
288
|
-
<p>option hash containing attributes for the new admin. Can contain: email,
|
|
289
|
-
name, orgAccess, tags and networks. See the Meraki API Documentation for
|
|
290
|
-
more details.</p>
|
|
291
|
-
</div>
|
|
292
|
-
|
|
293
|
-
</li>
|
|
294
|
-
|
|
295
|
-
</ul>
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
</div><table class="source_code">
|
|
299
|
-
<tr>
|
|
300
|
-
<td>
|
|
301
|
-
<pre class="lines">
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
15
|
|
305
|
-
16
|
|
306
|
-
17
|
|
307
|
-
18</pre>
|
|
308
|
-
</td>
|
|
309
|
-
<td>
|
|
310
|
-
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 15</span>
|
|
311
|
-
|
|
312
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_add_admin'>add_admin</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>
|
|
313
|
-
<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>
|
|
314
|
-
<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'>/admins</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>
|
|
315
|
-
<span class='kw'>end</span></pre>
|
|
316
|
-
</td>
|
|
317
|
-
</tr>
|
|
318
|
-
</table>
|
|
319
|
-
</div>
|
|
320
|
-
|
|
321
|
-
<div class="method_details ">
|
|
322
|
-
<h3 class="signature " id="list_admins-instance_method">
|
|
323
|
-
|
|
324
|
-
#<strong>list_admins</strong>(org_id) ⇒ <tt>Array</tt>
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
</h3><div class="docstring">
|
|
331
|
-
<div class="discussion">
|
|
332
|
-
|
|
333
|
-
<p>List all of the administrators for a given org</p>
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
</div>
|
|
337
|
-
</div>
|
|
338
|
-
<div class="tags">
|
|
339
|
-
<p class="tag_title">Parameters:</p>
|
|
340
|
-
<ul class="param">
|
|
341
|
-
|
|
342
|
-
<li>
|
|
343
|
-
|
|
344
|
-
<span class='name'>org_id</span>
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
—
|
|
352
|
-
<div class='inline'>
|
|
353
|
-
<p>organization ID you want the list of administrators for</p>
|
|
354
|
-
</div>
|
|
355
|
-
|
|
356
|
-
</li>
|
|
357
|
-
|
|
358
|
-
</ul>
|
|
359
|
-
|
|
360
|
-
<p class="tag_title">Returns:</p>
|
|
361
|
-
<ul class="return">
|
|
362
|
-
|
|
363
|
-
<li>
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
—
|
|
371
|
-
<div class='inline'>
|
|
372
|
-
<p>an array of hashes containing each admin and their attributes</p>
|
|
373
|
-
</div>
|
|
374
|
-
|
|
375
|
-
</li>
|
|
376
|
-
|
|
377
|
-
</ul>
|
|
378
|
-
|
|
379
|
-
</div><table class="source_code">
|
|
380
|
-
<tr>
|
|
381
|
-
<td>
|
|
382
|
-
<pre class="lines">
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
7
|
|
386
|
-
8
|
|
387
|
-
9</pre>
|
|
388
|
-
</td>
|
|
389
|
-
<td>
|
|
390
|
-
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 7</span>
|
|
391
|
-
|
|
392
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list_admins'>list_admins</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
393
|
-
<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'>/admins</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>
|
|
394
|
-
<span class='kw'>end</span></pre>
|
|
395
|
-
</td>
|
|
396
|
-
</tr>
|
|
397
|
-
</table>
|
|
398
|
-
</div>
|
|
399
|
-
|
|
400
|
-
<div class="method_details ">
|
|
401
|
-
<h3 class="signature " id="revoke_admin-instance_method">
|
|
402
|
-
|
|
403
|
-
#<strong>revoke_admin</strong>(org_id, admin_id) ⇒ <tt>Integer</tt>
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
</h3><div class="docstring">
|
|
410
|
-
<div class="discussion">
|
|
411
|
-
|
|
412
|
-
<p>Revoke an administrator for a specific org</p>
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
</div>
|
|
416
|
-
</div>
|
|
417
|
-
<div class="tags">
|
|
418
|
-
<p class="tag_title">Parameters:</p>
|
|
419
|
-
<ul class="param">
|
|
420
|
-
|
|
421
|
-
<li>
|
|
422
|
-
|
|
423
|
-
<span class='name'>org_id</span>
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
—
|
|
431
|
-
<div class='inline'>
|
|
432
|
-
<p>organization ID you want to revoke access on</p>
|
|
433
|
-
</div>
|
|
434
|
-
|
|
435
|
-
</li>
|
|
436
|
-
|
|
437
|
-
<li>
|
|
438
|
-
|
|
439
|
-
<span class='name'>admin_id</span>
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
—
|
|
447
|
-
<div class='inline'>
|
|
448
|
-
<p>ID of the administrator you want to revoke</p>
|
|
449
|
-
</div>
|
|
450
|
-
|
|
451
|
-
</li>
|
|
452
|
-
|
|
453
|
-
</ul>
|
|
454
|
-
|
|
455
|
-
<p class="tag_title">Returns:</p>
|
|
456
|
-
<ul class="return">
|
|
457
|
-
|
|
458
|
-
<li>
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
<span class='type'>(<tt>Integer</tt>)</span>
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
—
|
|
466
|
-
<div class='inline'>
|
|
467
|
-
<p>HTTP Code</p>
|
|
468
|
-
</div>
|
|
469
|
-
|
|
470
|
-
</li>
|
|
471
|
-
|
|
472
|
-
</ul>
|
|
473
|
-
|
|
474
|
-
</div><table class="source_code">
|
|
475
|
-
<tr>
|
|
476
|
-
<td>
|
|
477
|
-
<pre class="lines">
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
34
|
|
481
|
-
35
|
|
482
|
-
36</pre>
|
|
483
|
-
</td>
|
|
484
|
-
<td>
|
|
485
|
-
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 34</span>
|
|
486
|
-
|
|
487
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_revoke_admin'>revoke_admin</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_admin_id'>admin_id</span><span class='rparen'>)</span>
|
|
488
|
-
<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'>/admins/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_admin_id'>admin_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>
|
|
489
|
-
<span class='kw'>end</span></pre>
|
|
490
|
-
</td>
|
|
491
|
-
</tr>
|
|
492
|
-
</table>
|
|
493
|
-
</div>
|
|
494
|
-
|
|
495
|
-
<div class="method_details ">
|
|
496
|
-
<h3 class="signature " id="update_admin-instance_method">
|
|
497
|
-
|
|
498
|
-
#<strong>update_admin</strong>(org_id, admin_id, options) ⇒ <tt>Object</tt>
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
</h3><div class="docstring">
|
|
505
|
-
<div class="discussion">
|
|
506
|
-
|
|
507
|
-
<p>Update an administrator for a specific org</p>
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
</div>
|
|
511
|
-
</div>
|
|
512
|
-
<div class="tags">
|
|
513
|
-
<p class="tag_title">Parameters:</p>
|
|
514
|
-
<ul class="param">
|
|
515
|
-
|
|
516
|
-
<li>
|
|
517
|
-
|
|
518
|
-
<span class='name'>org_id</span>
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
—
|
|
526
|
-
<div class='inline'>
|
|
527
|
-
<p>organization ID you want to update an administrator on</p>
|
|
528
|
-
</div>
|
|
529
|
-
|
|
530
|
-
</li>
|
|
531
|
-
|
|
532
|
-
<li>
|
|
533
|
-
|
|
534
|
-
<span class='name'>admin_id</span>
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
—
|
|
542
|
-
<div class='inline'>
|
|
543
|
-
<p>ID of the admin you want to update</p>
|
|
544
|
-
</div>
|
|
545
|
-
|
|
546
|
-
</li>
|
|
547
|
-
|
|
548
|
-
<li>
|
|
549
|
-
|
|
550
|
-
<span class='name'>options</span>
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
—
|
|
558
|
-
<div class='inline'>
|
|
559
|
-
<p>hash containing the attributes and values you want to update. Can contain:
|
|
560
|
-
email, name, orgAccess, tags and networks. See the Meraki API Documentation
|
|
561
|
-
for more details.</p>
|
|
562
|
-
</div>
|
|
563
|
-
|
|
564
|
-
</li>
|
|
565
|
-
|
|
566
|
-
</ul>
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
</div><table class="source_code">
|
|
570
|
-
<tr>
|
|
571
|
-
<td>
|
|
572
|
-
<pre class="lines">
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
25
|
|
576
|
-
26
|
|
577
|
-
27
|
|
578
|
-
28</pre>
|
|
579
|
-
</td>
|
|
580
|
-
<td>
|
|
581
|
-
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 25</span>
|
|
582
|
-
|
|
583
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_admin'>update_admin</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_admin_id'>admin_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
584
|
-
<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>
|
|
585
|
-
<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'>/admins/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_admin_id'>admin_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>
|
|
586
|
-
<span class='kw'>end</span></pre>
|
|
587
|
-
</td>
|
|
588
|
-
</tr>
|
|
589
|
-
</table>
|
|
590
|
-
</div>
|
|
591
|
-
|
|
592
|
-
</div>
|
|
593
|
-
|
|
594
|
-
</div>
|
|
595
|
-
|
|
596
|
-
<div id="footer">
|
|
597
|
-
Generated on Thu Nov 17 22:15:39 2016 by
|
|
598
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
599
|
-
0.9.5 (ruby-2.3.0).
|
|
600
|
-
</div>
|
|
601
|
-
|
|
602
|
-
</div>
|
|
603
|
-
</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: Admins
|
|
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 = "Admins";
|
|
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 (A)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Admins</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: Admins
|
|
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/admins.rb</dd>
|
|
89
|
+
</dl>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
|
|
93
|
+
<h2>Overview</h2><div class="docstring">
|
|
94
|
+
<div class="discussion">
|
|
95
|
+
|
|
96
|
+
<p>Admins 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="#add_admin-instance_method" title="#add_admin (instance method)">#<strong>add_admin</strong>(org_id, options) ⇒ Object </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>Add an admin to a specific org.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#list_admins-instance_method" title="#list_admins (instance method)">#<strong>list_admins</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 of the administrators for a given org.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#revoke_admin-instance_method" title="#revoke_admin (instance method)">#<strong>revoke_admin</strong>(org_id, admin_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>Revoke an administrator for a specific org.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#update_admin-instance_method" title="#update_admin (instance method)">#<strong>update_admin</strong>(org_id, admin_id, options) ⇒ Object </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>Update an administrator for a specific org.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</ul>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<div id="instance_method_details" class="method_details_list">
|
|
237
|
+
<h2>Instance Method Details</h2>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<div class="method_details first">
|
|
241
|
+
<h3 class="signature first" id="add_admin-instance_method">
|
|
242
|
+
|
|
243
|
+
#<strong>add_admin</strong>(org_id, options) ⇒ <tt>Object</tt>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</h3><div class="docstring">
|
|
250
|
+
<div class="discussion">
|
|
251
|
+
|
|
252
|
+
<p>Add an admin to a specific org</p>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</div>
|
|
256
|
+
</div>
|
|
257
|
+
<div class="tags">
|
|
258
|
+
<p class="tag_title">Parameters:</p>
|
|
259
|
+
<ul class="param">
|
|
260
|
+
|
|
261
|
+
<li>
|
|
262
|
+
|
|
263
|
+
<span class='name'>org_id</span>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
—
|
|
271
|
+
<div class='inline'>
|
|
272
|
+
<p>organization ID you want to add an administrator to</p>
|
|
273
|
+
</div>
|
|
274
|
+
|
|
275
|
+
</li>
|
|
276
|
+
|
|
277
|
+
<li>
|
|
278
|
+
|
|
279
|
+
<span class='name'>options</span>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
—
|
|
287
|
+
<div class='inline'>
|
|
288
|
+
<p>option hash containing attributes for the new admin. Can contain: email,
|
|
289
|
+
name, orgAccess, tags and networks. See the Meraki API Documentation for
|
|
290
|
+
more details.</p>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
</ul>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
</div><table class="source_code">
|
|
299
|
+
<tr>
|
|
300
|
+
<td>
|
|
301
|
+
<pre class="lines">
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
15
|
|
305
|
+
16
|
|
306
|
+
17
|
|
307
|
+
18</pre>
|
|
308
|
+
</td>
|
|
309
|
+
<td>
|
|
310
|
+
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 15</span>
|
|
311
|
+
|
|
312
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_admin'>add_admin</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>
|
|
313
|
+
<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>
|
|
314
|
+
<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'>/admins</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>
|
|
315
|
+
<span class='kw'>end</span></pre>
|
|
316
|
+
</td>
|
|
317
|
+
</tr>
|
|
318
|
+
</table>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
<div class="method_details ">
|
|
322
|
+
<h3 class="signature " id="list_admins-instance_method">
|
|
323
|
+
|
|
324
|
+
#<strong>list_admins</strong>(org_id) ⇒ <tt>Array</tt>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
</h3><div class="docstring">
|
|
331
|
+
<div class="discussion">
|
|
332
|
+
|
|
333
|
+
<p>List all of the administrators for a given org</p>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</div>
|
|
337
|
+
</div>
|
|
338
|
+
<div class="tags">
|
|
339
|
+
<p class="tag_title">Parameters:</p>
|
|
340
|
+
<ul class="param">
|
|
341
|
+
|
|
342
|
+
<li>
|
|
343
|
+
|
|
344
|
+
<span class='name'>org_id</span>
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
—
|
|
352
|
+
<div class='inline'>
|
|
353
|
+
<p>organization ID you want the list of administrators for</p>
|
|
354
|
+
</div>
|
|
355
|
+
|
|
356
|
+
</li>
|
|
357
|
+
|
|
358
|
+
</ul>
|
|
359
|
+
|
|
360
|
+
<p class="tag_title">Returns:</p>
|
|
361
|
+
<ul class="return">
|
|
362
|
+
|
|
363
|
+
<li>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
—
|
|
371
|
+
<div class='inline'>
|
|
372
|
+
<p>an array of hashes containing each admin and their attributes</p>
|
|
373
|
+
</div>
|
|
374
|
+
|
|
375
|
+
</li>
|
|
376
|
+
|
|
377
|
+
</ul>
|
|
378
|
+
|
|
379
|
+
</div><table class="source_code">
|
|
380
|
+
<tr>
|
|
381
|
+
<td>
|
|
382
|
+
<pre class="lines">
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
7
|
|
386
|
+
8
|
|
387
|
+
9</pre>
|
|
388
|
+
</td>
|
|
389
|
+
<td>
|
|
390
|
+
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 7</span>
|
|
391
|
+
|
|
392
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list_admins'>list_admins</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='rparen'>)</span>
|
|
393
|
+
<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'>/admins</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>
|
|
394
|
+
<span class='kw'>end</span></pre>
|
|
395
|
+
</td>
|
|
396
|
+
</tr>
|
|
397
|
+
</table>
|
|
398
|
+
</div>
|
|
399
|
+
|
|
400
|
+
<div class="method_details ">
|
|
401
|
+
<h3 class="signature " id="revoke_admin-instance_method">
|
|
402
|
+
|
|
403
|
+
#<strong>revoke_admin</strong>(org_id, admin_id) ⇒ <tt>Integer</tt>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
</h3><div class="docstring">
|
|
410
|
+
<div class="discussion">
|
|
411
|
+
|
|
412
|
+
<p>Revoke an administrator for a specific org</p>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
</div>
|
|
416
|
+
</div>
|
|
417
|
+
<div class="tags">
|
|
418
|
+
<p class="tag_title">Parameters:</p>
|
|
419
|
+
<ul class="param">
|
|
420
|
+
|
|
421
|
+
<li>
|
|
422
|
+
|
|
423
|
+
<span class='name'>org_id</span>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
—
|
|
431
|
+
<div class='inline'>
|
|
432
|
+
<p>organization ID you want to revoke access on</p>
|
|
433
|
+
</div>
|
|
434
|
+
|
|
435
|
+
</li>
|
|
436
|
+
|
|
437
|
+
<li>
|
|
438
|
+
|
|
439
|
+
<span class='name'>admin_id</span>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
—
|
|
447
|
+
<div class='inline'>
|
|
448
|
+
<p>ID of the administrator you want to revoke</p>
|
|
449
|
+
</div>
|
|
450
|
+
|
|
451
|
+
</li>
|
|
452
|
+
|
|
453
|
+
</ul>
|
|
454
|
+
|
|
455
|
+
<p class="tag_title">Returns:</p>
|
|
456
|
+
<ul class="return">
|
|
457
|
+
|
|
458
|
+
<li>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
—
|
|
466
|
+
<div class='inline'>
|
|
467
|
+
<p>HTTP Code</p>
|
|
468
|
+
</div>
|
|
469
|
+
|
|
470
|
+
</li>
|
|
471
|
+
|
|
472
|
+
</ul>
|
|
473
|
+
|
|
474
|
+
</div><table class="source_code">
|
|
475
|
+
<tr>
|
|
476
|
+
<td>
|
|
477
|
+
<pre class="lines">
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
34
|
|
481
|
+
35
|
|
482
|
+
36</pre>
|
|
483
|
+
</td>
|
|
484
|
+
<td>
|
|
485
|
+
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 34</span>
|
|
486
|
+
|
|
487
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_revoke_admin'>revoke_admin</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_admin_id'>admin_id</span><span class='rparen'>)</span>
|
|
488
|
+
<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'>/admins/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_admin_id'>admin_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>
|
|
489
|
+
<span class='kw'>end</span></pre>
|
|
490
|
+
</td>
|
|
491
|
+
</tr>
|
|
492
|
+
</table>
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
<div class="method_details ">
|
|
496
|
+
<h3 class="signature " id="update_admin-instance_method">
|
|
497
|
+
|
|
498
|
+
#<strong>update_admin</strong>(org_id, admin_id, options) ⇒ <tt>Object</tt>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</h3><div class="docstring">
|
|
505
|
+
<div class="discussion">
|
|
506
|
+
|
|
507
|
+
<p>Update an administrator for a specific org</p>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</div>
|
|
511
|
+
</div>
|
|
512
|
+
<div class="tags">
|
|
513
|
+
<p class="tag_title">Parameters:</p>
|
|
514
|
+
<ul class="param">
|
|
515
|
+
|
|
516
|
+
<li>
|
|
517
|
+
|
|
518
|
+
<span class='name'>org_id</span>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
—
|
|
526
|
+
<div class='inline'>
|
|
527
|
+
<p>organization ID you want to update an administrator on</p>
|
|
528
|
+
</div>
|
|
529
|
+
|
|
530
|
+
</li>
|
|
531
|
+
|
|
532
|
+
<li>
|
|
533
|
+
|
|
534
|
+
<span class='name'>admin_id</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
—
|
|
542
|
+
<div class='inline'>
|
|
543
|
+
<p>ID of the admin you want to update</p>
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
</li>
|
|
547
|
+
|
|
548
|
+
<li>
|
|
549
|
+
|
|
550
|
+
<span class='name'>options</span>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
—
|
|
558
|
+
<div class='inline'>
|
|
559
|
+
<p>hash containing the attributes and values you want to update. Can contain:
|
|
560
|
+
email, name, orgAccess, tags and networks. See the Meraki API Documentation
|
|
561
|
+
for more details.</p>
|
|
562
|
+
</div>
|
|
563
|
+
|
|
564
|
+
</li>
|
|
565
|
+
|
|
566
|
+
</ul>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
</div><table class="source_code">
|
|
570
|
+
<tr>
|
|
571
|
+
<td>
|
|
572
|
+
<pre class="lines">
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
25
|
|
576
|
+
26
|
|
577
|
+
27
|
|
578
|
+
28</pre>
|
|
579
|
+
</td>
|
|
580
|
+
<td>
|
|
581
|
+
<pre class="code"><span class="info file"># File 'lib/admins.rb', line 25</span>
|
|
582
|
+
|
|
583
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_admin'>update_admin</span><span class='lparen'>(</span><span class='id identifier rubyid_org_id'>org_id</span><span class='comma'>,</span> <span class='id identifier rubyid_admin_id'>admin_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
584
|
+
<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>
|
|
585
|
+
<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'>/admins/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_admin_id'>admin_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>
|
|
586
|
+
<span class='kw'>end</span></pre>
|
|
587
|
+
</td>
|
|
588
|
+
</tr>
|
|
589
|
+
</table>
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
</div>
|
|
593
|
+
|
|
594
|
+
</div>
|
|
595
|
+
|
|
596
|
+
<div id="footer">
|
|
597
|
+
Generated on Thu Nov 17 22:15:39 2016 by
|
|
598
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
599
|
+
0.9.5 (ruby-2.3.0).
|
|
600
|
+
</div>
|
|
601
|
+
|
|
602
|
+
</div>
|
|
603
|
+
</body>
|
|
604
604
|
</html>
|