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