Skip to Content

Wiki source code of Users

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