Wiki source code of Users

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.2+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 The live user REST resource allows access to information about the state of users in the system. There are currently no actions that can be performed on a user.
15 {{/layout-cell}}
16
17 {{layout-cell}}
18 {{panel title="On this page:"}}
19
20
21 {{toc maxLevel="2" indent="1"/}}
22 {{/panel}}
23 {{/layout-cell}}
24 {{/layout-section}}
25
26 {{layout-section ac:type="single"}}
27 {{layout-cell}}
28 (% style="color: rgb(0,0,0);" %)
29
30
31 = (% style="color: rgb(0,0,0);" %)JSON Representation(%%) =
32
33 {{code}}
34 {
35 "id": "cb250fe1-a20d-4cf8-a4c2-a8454fd5fc4f",
36 "configurationId": "ed38fe4d-13ad-4fd0-be25-d3404c421370",
37 "userName": "4224",
38 "displayedName": "Michael Y (desk)",
39 "permissionId": "ed38fe4d-13ad-4fd0-be25-d3404c421370"
40 }
41 {{/code}}
42
43 |=(((
44 Property
45 )))|=(((
46 Type
47 )))|=(((
48 Description
49 )))
50 |(((
51 {{{id}}}
52 )))|(((
53 String
54 )))|(((
55 The id of the user.
56 )))
57 |(% colspan="1" %)(% colspan="1" %)
58 (((
59 {{{configurationId}}}
60 )))|(% colspan="1" %)(% colspan="1" %)
61 (((
62 String
63 )))|(% colspan="1" %)(% colspan="1" %)
64 (((
65 The id of the configuration object that represents the user.
66 )))
67 |(% colspan="1" %)(% colspan="1" %)
68 (((
69 {{{userName}}}
70 )))|(% colspan="1" %)(% colspan="1" %)
71 (((
72 String
73 )))|(% colspan="1" %)(% colspan="1" %)
74 (((
75 The username of the user.
76 )))
77 |(% colspan="1" %)(% colspan="1" %)
78 (((
79 displayedName
80 )))|(% colspan="1" %)(% colspan="1" %)
81 (((
82 String
83 )))|(% colspan="1" %)(% colspan="1" %)
84 (((
85 The display name of the user.
86 )))
87 |(% colspan="1" %)(% colspan="1" %)
88 (((
89 permissionId
90 )))|(% colspan="1" %)(% colspan="1" %)
91 (((
92 String
93 )))|(% colspan="1" %)(% colspan="1" %)
94 (((
95 The user's permission id.
96 )))
97
98 = Root Resource Paths =
99
100 Paths used to access sets of the resource, in relation to parent resources.
101
102 |=(% colspan="2" %)(% colspan="2" %)
103 (((
104 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users}}}
105 )))
106 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
107 (((
108 **Description**
109 )))|(((
110 Provides access to all users in the specified core server.
111
112 **Parameters:**
113
114 * core_server_id: the id of the parent core server
115 * core_server_slug: the slug of the parent core server
116
117 **Errors:**
118
119 * 404 Not Found: Returned if no core server with the given id or slug exists
120 )))
121 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
122 (((
123 **GET**
124 )))|(((
125 Gets all users in the specified core server.
126 )))
127
128 = (% style="color: rgb(0,0,0);" %)Instance Resource Paths(%%) =
129
130 Paths used to access a specific instance of the resource.
131
132 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
133 (((
134 {{{{root_resource_path}/{user_id}}}}
135 )))
136 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
137 (((
138 **Description**
139 )))|(((
140 Provides access to a specific user, by user id.
141
142 **Parameters:**
143
144 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above\\
145 * user_id: the id of the user to access
146
147 **Errors:**
148
149 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
150 * 404 Not Found: Returned if no user with the given id exists
151 )))
152 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
153 (((
154 **GET**
155 )))|(((
156 Gets the specified user.
157 )))
158 |(% colspan="2" %)(% colspan="2" %)
159 (((
160
161 )))
162 |=(% colspan="2" %)(% colspan="2" %)
163 (((
164 {{{{root_resource_path}/getByName/{username}}}}
165 )))
166 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
167 (((
168 **Description**
169 )))|(% colspan="1" %)(% colspan="1" %)
170 (((
171 Provides access to a specific user, by username.
172
173 **Parameters:**
174
175 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above\\
176 * username: the username of the user to access
177
178 **Errors:**
179
180 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
181 * 404 Not Found: Returned if no user with the given username exists
182 )))
183 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
184 (((
185 **GET**
186 )))|(% colspan="1" %)(% colspan="1" %)
187 (((
188 Gets the specified user.
189 )))
190
191 = (% style="color: rgb(0,0,0);" %)Sub Resource Paths(%%) =
192
193 Paths used to access the child resources of this resource.
194
195 |=(% colspan="2" %)(% colspan="2" %)
196 (((
197 {{{{instance_resource_path}/logins}}}
198 )))
199 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
200 (((
201 **Description**
202 )))|(% colspan="1" %)(% colspan="1" %)
203 (((
204 Provides access to the active logins for the specified user. See [[doc:Logins]].
205
206 **Parameters:**
207
208 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
209
210 **Errors:**
211
212 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
213 )))
214 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
215 (((
216 **GET**
217 )))|(% colspan="1" %)(% colspan="1" %)
218 (((
219 Gets all active logins for the specified user.
220 )))
221 |(% colspan="2" %)(% colspan="2" %)
222 (((
223
224 )))
225 |=(% colspan="2" %)(% colspan="2" %)
226 (((
227 {{{{instance_resource_path}/status}}}
228 )))
229 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
230 (((
231 **Description**
232 )))|(% colspan="1" %)(% colspan="1" %)
233 (((
234 Provides access to the status of the specified user. See [[doc:Status]].
235
236 **Parameters:**
237
238 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
239
240 **Errors:**
241
242 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
243 )))
244 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
245 (((
246 **GET**
247 )))|(% colspan="1" %)(% colspan="1" %)
248 (((
249 Get the status of the specified user.
250 )))
251 |(% colspan="2" %)(% colspan="2" %)
252 (((
253
254 )))
255 |=(% colspan="2" %)(% colspan="2" %)
256 (((
257 {{{{instance_resource_path}/extensions}}}
258 )))
259 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
260 (((
261 **Description**
262 )))|(% colspan="1" %)(% colspan="1" %)
263 (((
264 Provides access to the extensions of the specified user. See [[doc:Extensions]].
265
266 {{info}}
267 Excludes any extensions that are not bound to a licensed/full user.
268 {{/info}}
269
270 (% style="line-height: 1.4285715;" %)**Parameters:**
271
272 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
273
274 **Errors:**
275
276 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
277 )))
278
279 =
280 Curl Examples =
281
282 === Gets all users in a core server ===
283
284 {{code language="bash"}}
285 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users
286 {{/code}}
287
288 === Gets a specific user in a core server ===
289
290 {{code language="bash"}}
291 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/4aff6119-54e8-4884-bff6-f76c7dddf74b
292 {{/code}}
293 {{/layout-cell}}
294 {{/layout-section}}
295 {{/layout}}

Search

Navigation

iSymphony