Skip to Content

Wiki source code of Administrator Configuration

Version 16.1 by michaely on 2016/05/28 21:37
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 {{warning}}
5 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
6 {{/warning}}
7
8 {{info}}
9 The information on this page applies to **iSymphony 3.1+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 The administrator REST resource allows access to the configuration for system administrators.
15
16
17 {{/layout-cell}}
18
19 {{layout-cell}}
20 {{panel title="On this page:"}}
21
22
23 {{toc maxLevel="2" indent="1"/}}
24 {{/panel}}
25 {{/layout-cell}}
26 {{/layout-section}}
27
28 {{layout-section ac:type="single"}}
29 {{layout-cell}}
30 = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) =
31
32 {{code}}
33 communication_manager/rest/config/server/administrators
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "id": "ee828da8-5ee6-413d-82ac-1273f598659d",
41 "userName": "admin",
42 "password": "d36c07e15f98bea42b1cd80bca5b5ce4d9131c68",
43 "superUser": true
44 }
45 {{/code}}
46
47 |=(((
48 Property
49 )))|=(((
50 Type
51 )))|=(((
52 Description
53 )))
54 |(((
55 {{{id}}}
56 )))|(((
57 String
58 )))|(((
59 Configuration id of the administrator.
60 )))
61 |(% colspan="1" %)(% colspan="1" %)
62 (((
63 userName
64 )))|(% colspan="1" %)(% colspan="1" %)
65 (((
66 String
67 )))|(% colspan="1" %)(% colspan="1" %)
68 (((
69 Username of the Administrator.
70 )))
71 |(% colspan="1" %)(% colspan="1" %)
72 (((
73 password
74 )))|(% colspan="1" %)(% colspan="1" %)
75 (((
76 String
77 )))|(% colspan="1" %)(% colspan="1" %)
78 (((
79 SHA-1 hash of the administrators password.
80 )))
81 |(% colspan="1" %)(% colspan="1" %)
82 (((
83 superUser
84 )))|(% colspan="1" %)(% colspan="1" %)
85 (((
86 Boolean
87 )))|(% colspan="1" %)(% colspan="1" %)
88 (((
89 Flags specifiying if the administrator is a super admin.
90 )))
91
92 == Resource Paths ==
93
94 |=(% colspan="2" %)(% colspan="2" %)
95 (((
96 {{{communication_manager/rest/config/server/administrators}}}
97 )))
98 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
99 (((
100 **Description**
101 )))|(((
102 Accesses all the administrators in the system.
103 )))
104 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
105 (((
106 **GET**
107 )))|(((
108 Gets all the administrators in the system.
109 )))
110 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
111 (((
112 **POST
113 **
114 )))|(% colspan="1" %)(% colspan="1" %)
115 (((
116 Adds an administrator to the configuration.
117
118 **Errors:**
119
120 * 409 'An administrator with the given id already exists.': Returned if an administrator with the given id already exists.
121 * 409 'An administrator with the given username already exists.': Returned if an administrator with the given username already exists.
122 )))
123 |(% colspan="2" %)(% colspan="2" %)
124 (((
125
126 )))
127 |=(% colspan="2" %)(% colspan="2" %)
128 (((
129 {{{communication_manager/rest/config/server/administrators/{id}}}}
130 )))
131 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
132 (((
133 **Description**
134 )))|(((
135 Accesses the configuration model for the specified core server.
136
137 **Parameters:**
138
139 * core_server_id: The UUID of the core server.
140
141 **Errors:**
142
143 * 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
144 )))
145 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
146 (((
147 **GET**
148 )))|(((
149 Gets the chat configuration model for the specified core server.
150 )))
151
152 = Sub/Child Resource Paths =
153
154 |=(% colspan="2" %)(% colspan="2" %)
155 (((
156 {{{communication_manager/api/resource/core/{core_server_id}/users}}}
157 )))
158 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
159 (((
160 **Description**
161 )))|(% colspan="1" %)(% colspan="1" %)
162 (((
163 Access the sub/child resource for users, in a specified core server, via the core server id.
164
165 **Parameters:**
166
167 * core_server_id: The UUID of the core server.
168
169 **Errors:**
170
171 * 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
172
173 See User Configuration for more information.
174 )))
175 |(% colspan="2" %)(% colspan="2" %)
176 (((
177
178 )))
179 |=(% colspan="2" %)(% colspan="2" %)
180 (((
181 {{{communication_manager/api/resource/core/{core_server_id}/statuses}}}
182 )))
183 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
184 (((
185 **Description**
186 )))|(% colspan="1" %)(% colspan="1" %)
187 (((
188 Access the sub/child resource for statuses, in a specified core server via the via the core server id.
189
190 **Parameters:**
191
192 * core_server_id: The UUID of the core server.
193
194 **Errors:**
195
196 * (((
197 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
198 )))
199
200 See User Configuration for more information.
201 )))
202 |(% colspan="2" %)(% colspan="2" %)
203 (((
204
205 )))
206 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
207 (((
208 {{{communication_manager/api/resource/core/{core_server_id}/userGroups}}}
209 )))
210 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
211 (((
212 **Description**
213 )))|(((
214 Access the sub/child resource for user groups, in a specified core server via the via the core server id.
215
216 **Parameters:**
217
218 * core_server_id: The UUID of the core server.
219
220 **Errors:**
221
222 * (((
223 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
224 )))
225
226 See User Group Configuration for more information.
227 )))
228 |(% colspan="2" %)(% colspan="2" %)
229 (((
230
231 )))
232 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
233 (((
234 {{{communication_manager/api/resource/core/{core_server_id}/permissions}}}
235 )))
236 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
237 (((
238 **Description**
239 )))|(% colspan="1" %)(% colspan="1" %)
240 (((
241 Access the sub/child resource for permissions, in a specified core server via the via the core server id.
242
243 **Parameters:**
244
245 * core_server_id: The UUID of the core server.
246
247 **Errors:**
248
249 * (((
250 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
251 )))
252
253 See [[doc:Permissions Configuration]] for more information.
254 )))
255 |(% colspan="2" %)(% colspan="2" %)
256 (((
257
258 )))
259 |=(% colspan="2" %)(% colspan="2" %)
260 (((
261 {{{communication_manager/api/resource/core/{core_server_id}/authToken}}}
262 )))
263 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
264 (((
265 **Description**
266 )))|(% colspan="1" %)(% colspan="1" %)
267 (((
268 Access the sub/child resource for creating authentication tokens, via the core server id.
269
270 For JSON used to in the request and response for this resource see [[Session Authentication Token>>doc:||anchor="auth_token_rest_json"]] above.
271
272 **Parameters:**
273
274 * core_server_id: The UUID of the core server.
275
276 **Errors:**
277
278 * (((
279 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
280 )))
281
282 See Authentication Tokens for more information.
283 )))
284
285 = Curl Examples =
286
287 === Get configuration for all core servers ===
288
289 {{code language="bash"}}
290 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/api/resource/core
291 {{/code}}
292
293 === Get the configuration for a specific core server ===
294
295 {{code language="bash"}}
296 curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7
297 {{/code}}
298
299 === Request an authentication session token ===
300
301 {{code language="bash"}}
302 curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"username":"johnd","password":"pass"}' http://localhost:55050/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7/authToken
303 {{/code}}
304 {{/layout-cell}}
305 {{/layout-section}}
306 {{/layout}}