Wiki source code of XMPP Profile Configuration

Last modified by michaely on 2021/09/10 23:34
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 XMPP REST resource that allows access to a user's XMPP profile configuration. This resource can be used to specify the XMPP login credentials for a user and override the server host, port, domain, and resource for the user's XMPP connection.
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/api/resource/xmpp/[{core_server_id} | getBySlug/{core_server_slug}]/profiles
34 {{/code}}
35
36 = JSON Representation =
37
38 {{code}}
39 {
40 "userConfigurationId": "cf01f6f0-3e91-11e4-916c-0800200c9a66",
41 "serverHost": "other.myxmppserver.com",
42 "serverPort": 5222,
43 "domain": "mydomain",
44 "resource": "myresource",
45 "username": "mike",
46 "password": "mypassword"
47 }
48 {{/code}}
49
50 |=(((
51 Property
52 )))|=(((
53 Type
54 )))|=(((
55 Description
56 )))
57 |(((
58 {{{userConfigurationId}}}
59 )))|(((
60 String(UUID)
61 )))|(((
62 Specifies the UUID of the user configuration object the profile is associated with.
63 )))
64 |(% colspan="1" %)(% colspan="1" %)
65 (((
66 {{{serverHost}}}
67 )))|(% colspan="1" %)(% colspan="1" %)
68 (((
69 String
70 )))|(% colspan="1" %)(% colspan="1" %)
71 (((
72 Specifies an override for the user's XMPP server connection host value. Set to blank string to utilize the globally set host.
73 )))
74 |(% colspan="1" %)(% colspan="1" %)
75 (((
76 {{{serverPort}}}
77 )))|(% colspan="1" %)(% colspan="1" %)
78 (((
79 Integer
80 )))|(% colspan="1" %)(% colspan="1" %)
81 (((
82 Specifies an override for the user's XMPP server connection port value. Set to -1 to utilize the globally set port.
83 )))
84 |(% colspan="1" %)(% colspan="1" %)
85 (((
86 domain
87 )))|(% colspan="1" %)(% colspan="1" %)
88 (((
89 String
90 )))|(% colspan="1" %)(% colspan="1" %)
91 (((
92 Specifies an override for the user's XMPP connection domain.
93 )))
94 |(% colspan="1" %)(% colspan="1" %)
95 (((
96 resource
97 )))|(% colspan="1" %)(% colspan="1" %)
98 (((
99 String
100 )))|(% colspan="1" %)(% colspan="1" %)
101 (((
102 Specifies an override for the user's XMPP connection resource.
103 )))
104 |(% colspan="1" %)(% colspan="1" %)
105 (((
106 {{{username}}}
107 )))|(% colspan="1" %)(% colspan="1" %)
108 (((
109 String
110 )))|(% colspan="1" %)(% colspan="1" %)
111 (((
112 The XMPP login user name to use for the server.
113 )))
114 |(% colspan="1" %)(% colspan="1" %)
115 (((
116 {{{password}}}
117 )))|(% colspan="1" %)(% colspan="1" %)
118 (((
119 String
120 )))|(% colspan="1" %)(% colspan="1" %)
121 (((
122 The XMPP loign password to use for the server.
123 )))
124
125 = Resource Paths =
126
127 |=(% colspan="2" %)(% colspan="2" %)
128 (((
129 communication_manager/api/resource/xmpp/{core_server_id}/profiles
130
131 {{{}}}
132 )))
133 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
134 (((
135 **Description**
136 )))|(((
137 Accesses all XMPP profiles for all users in the specified core server.
138
139 **Parameters:**
140
141 * core_server_id: The UUID of the core server.
142
143 **Errors:**
144
145 * 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
146 )))
147 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
148 (((
149 **GET**
150 )))|(((
151 Gets all the XMPP profile configuration for all users in the specified core server.
152 )))
153 |(% colspan="2" %)(% colspan="2" %)
154 (((
155
156 )))
157 |=(% colspan="2" %)(% colspan="2" %)
158 (((
159 {{{communication_manager/api/resource/xmpp/getBySlug/{core_server_slug}/profiles}}}
160 )))
161 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
162 (((
163 **Description**
164 )))|(% colspan="1" %)(% colspan="1" %)
165 (((
166 Accesses all XMPP profiles for all users in the specified core server via the core server slug/unique id.
167
168 **Parameters:**
169
170 * core_server_slug: The slug/unique id of the core server.
171
172 **Errors:**
173
174 * 404 'Failed to locate the core server.': Returned if no core server exists with the given slug.
175 )))
176 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
177 (((
178 **GET**
179 )))|(% colspan="1" %)(% colspan="1" %)
180 (((
181 Gets all the XMPP profile configuration for all users in the specified core server.
182 )))
183 |(% colspan="2" %)(% colspan="2" %)
184 (((
185
186 )))
187 |=(% colspan="2" %)(% colspan="2" %)
188 (((
189 {{{communication_manager/api/resource/xmpp/{core_server_id}/profiles/{user_configuration_id}}}}
190 )))
191 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
192 (((
193 **Description**
194 )))|(% colspan="1" %)(% colspan="1" %)
195 (((
196 Accesses the XMPP profile for a user in a specified core server via the core server id and the user's configuration id.
197
198 **Parameters:**
199
200 * core_server_id: The UUID of the core server.
201 * user_configuration_id: The UUID of the user configuration.
202
203 **Errors:**
204
205 * 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
206 * 404 'Failed to locate the user configuration.': Returned if no user exists with the given id.
207 * 412 'No username provided.': Returned if no username was provided during a PUT.
208 * 412 'No password provided.': Returned if no password was provided during a PUT.
209 * 412 'No serverHost provided.': Returned if no server host was provided during a PUT.
210 * 412 'No domain provided.': Returned if no domain was provided during a PUT.
211 * 412 'No resource provided.': Returned if no resource was provided during a PUT.
212 )))
213 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
214 (((
215 **GET**
216 )))|(% colspan="1" %)(% colspan="1" %)
217 (((
218 Gets the XMPP profile configuration for the user in the specified core server.
219 )))
220 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
221 (((
222 **PUT**
223 )))|(((
224 Updates the XMPP profile configuration for the user in the specified core server.
225 )))
226 |(% colspan="2" %)(% colspan="2" %)
227 (((
228
229 )))
230 |=(% colspan="2" %)(% colspan="2" %)
231 (((
232 {{{communication_manager/api/resource/xmpp/getBySlug/{core_server_slug}/profiles/{user_configuration_id}}}}
233 )))
234 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
235 (((
236 **Description**
237 )))|(% colspan="1" %)(% colspan="1" %)
238 (((
239 Accesses the XMPP profile for a user in a specified core server via the core server slug/unique id and the user's configuration id.
240
241 **Parameters:**
242
243 * core_server_slug: The slug/unique id of the core server.
244 * user_configuration_id: The UUID of the user configuration.
245
246 **Errors:**
247
248 * 404 'Failed to locate the core server.': Returned if no core server exists with the given slug.
249 * 404 'Failed to locate the user configuration.': Returned if no user exists with the given id.
250 * 412 'No username provided.': Returned if no username was provided during a PUT.
251 * 412 'No password provided.': Returned if no password was provided during a PUT.
252 * 412 'No serverHost provided.': Returned if no server host was provided during a PUT.
253 * 412 'No domain provided.': Returned if no domain was provided during a PUT.
254 * 412 'No resource provided.': Returned if no resource was provided during a PUT.
255 )))
256 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
257 (((
258 **GET**
259 )))|(% colspan="1" %)(% colspan="1" %)
260 (((
261 Gets the XMPP profile configuration for the user in the specified core server.
262 )))
263 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
264 (((
265 **PUT**
266 )))|(% colspan="1" %)(% colspan="1" %)
267 (((
268 Updates the XMPP profile configuration for the user in the specified core server.
269 )))
270 |(% colspan="2" %)(% colspan="2" %)
271 (((
272
273 )))
274 |=(% colspan="2" %)(% colspan="2" %)
275 (((
276 {{{communication_manager/api/resource/xmpp/{core_server_id}/profiles/getByUsername/{username}}}}
277 )))
278 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
279 (((
280 **Description**
281 )))|(% colspan="1" %)(% colspan="1" %)
282 (((
283 Accesses the XMPP profile for a user in a specified core server via the core server slug/unique id and the user's username.
284
285 **Parameters:**
286
287 * core_server_slug: The slug/unique id of the core server.
288 * username: The username of the user.
289
290 **Errors:**
291
292 * 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
293 * 404 'User with the specified username was not found.': Returned if no user exists with the given username.
294 * 412 'No username provided.': Returned if no username was provided during a PUT.
295 * 412 'No password provided.': Returned if no password was provided during a PUT.
296 * 412 'No serverHost provided.': Returned if no server host was provided during a PUT.
297 * 412 'No domain provided.': Returned if no domain was provided during a PUT.
298 * 412 'No resource provided.': Returned if no resource was provided during a PUT.
299 )))
300 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
301 (((
302 **GET**
303 )))|(% colspan="1" %)(% colspan="1" %)
304 (((
305 Gets the XMPP profile configuration for the user in the specified core server.
306 )))
307 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
308 (((
309 **PUT**
310 )))|(% colspan="1" %)(% colspan="1" %)
311 (((
312 Updates the XMPP profile configuration for the user in the specified core server.
313 )))
314 |(% colspan="2" %)(% colspan="2" %)
315 (((
316
317 )))
318 |=(% colspan="2" %)(% colspan="2" %)
319 (((
320 {{{communication_manager/api/resource/xmpp/getBySlug/{core_server_slug}/profiles/getByUsername/{username}}}}
321 )))
322 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
323 (((
324 **Description**
325 )))|(% colspan="1" %)(% colspan="1" %)
326 (((
327 Accesses the XMPP profile for a user in a specified core server via the core server slug/unique id and the user's username.
328
329 **Parameters:**
330
331 * core_server_slug: The slug/unique id of the core server.
332 * username: The username of the user.
333
334 **Errors:**
335
336 * 404 'Failed to locate the core server.': Returned if no core server exists with the given slug.
337 * 404 'User with the specified username was not found.': Returned if no user exists with the given username.
338 * 412 'No username provided.': Returned if no username was provided during a PUT.
339 * 412 'No password provided.': Returned if no password was provided during a PUT.
340 * 412 'No serverHost provided.': Returned if no server host was provided during a PUT.
341 * 412 'No domain provided.': Returned if no domain was provided during a PUT.
342 * 412 'No resource provided.': Returned if no resource was provided during a PUT.
343 )))
344 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
345 (((
346 **GET**
347 )))|(% colspan="1" %)(% colspan="1" %)
348 (((
349 Gets the XMPP profile configuration for the user in the specified core server.
350 )))
351 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
352 (((
353 **PUT**
354 )))|(% colspan="1" %)(% colspan="1" %)
355 (((
356 Updates the XMPP profile configuration for the user in the specified core server.
357 )))
358
359 = Curl Examples =
360
361 === Get the XMPP profile for the user 'michaely' in core server 'default' ===
362
363 {{code language="bash"}}
364 curl --user manager:manag3rpa55word -i -k -H "Accept: application/json" http://localhost:58080/communication_manager/api/resource/xmpp/getBySlug/default/profiles/getByUsername/michaely
365 {{/code}}
366
367 === Update the XMPP profile for the user 'michaely' in core server 'default' ===
368
369 {{code language="bash"}}
370 curl --user manager:manag3rpa55word -i -k -H "Content-Type: application/json" -X PUT -d '{"serverHost": "other.myxmppserver.com", "serverPort": 5222, "domain": "mydomain", "resource": "myresource", "username": "mike", "password": "mypassword"}' http://localhost:58080/communication_manager/api/resource/xmpp/getBySlug/default/profiles/getByUsername/michaely
371 {{/code}}
372 {{/layout-cell}}
373 {{/layout-section}}
374 {{/layout}}

Search

Navigation

iSymphony