Skip to Content

Changes for page Permissions Configuration

Last modified by colinw on 2021/09/10 23:34
From version 8.1
edited by colinw
on 2014/11/15 22:00
Change comment: Enabling/disabling permissions for a core server.
To version 16.3
edited by colinw
on 2021/09/10 23:34
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +iSymphony Developer Documentation.REST API Documentation.Configuration API.WebHome
Content
... ... @@ -140,15 +140,15 @@
140 140  )))|(((
141 141  Sets whether permissions are enabled or disabled globally on the core server.
142 142  )))
143 -
144 144  |=(% colspan="2" %)(% colspan="2" %)
145 145  (((
146 146  {{{communication_manager/api/resource/core/{core_server_id}/permissions/userGroup/{user_group_id}}}}
147 147  )))
148 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
147 +|=(% colspan="1" %)(% colspan="1" %)
149 149  (((
150 -**Description**
151 -)))|(((
149 +Description
150 +)))|(% colspan="1" %)(% colspan="1" %)
151 +(((
152 152  Retrieves permissions for the user group identified by the {user_group_id} path parameter.
153 153  
154 154  **Parameters**:
... ... @@ -161,19 +161,18 @@
161 161  
162 162  * 404 'No user group exists with that id.': Returned if the provided user_group_id does not match a user group in the system.
163 163  )))
164 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
164 +|=(% colspan="1" %)(% colspan="1" %)
165 165  (((
166 -**GET**
167 -)))|(((
166 +GET
167 +)))|(% colspan="1" %)(% colspan="1" %)
168 +(((
168 168  Retrieves all permissions defined for the user group.
169 169  )))
170 -
171 171  |=(% colspan="2" %)(% colspan="2" %)
172 172  (((
173 173  {{{communication_manager/api/resource/core/{core_server_id}/permissions/userGroup/{user_group_id}/{key}}}}
174 174  )))
175 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
176 -(((
175 +|=(((
177 177  **Description**
178 178  )))|(((
179 179  Retrieves or updates a specific permission for a user group.
... ... @@ -192,10 +192,11 @@
192 192  
193 193  * 404 'No user group exists with that id.': Returned if the provided user_group_id does not match a user group in the system.
194 194  )))
195 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
194 +|=(% colspan="1" %)(% colspan="1" %)
196 196  (((
197 197  **GET**
198 -)))|(((
197 +)))|(% colspan="1" %)(% colspan="1" %)
198 +(((
199 199  Retrieves a specific permission for the user group.
200 200  
201 201  **Errors**:
... ... @@ -202,10 +202,11 @@
202 202  
203 203  * 404 'No permission with that key is defined for that user group.': Returned if there is no permission defined for the user group with that permission key.
204 204  )))
205 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
205 +|=(% colspan="1" %)(% colspan="1" %)
206 206  (((
207 207  **PUT**
208 -)))|(((
208 +)))|(% colspan="1" %)(% colspan="1" %)
209 +(((
209 209  Sets the permission definition for the user group with the specified key. The key defined in the permission definition body must match the key used in the URL.
210 210  
211 211  **Errors**:
... ... @@ -213,7 +213,7 @@
213 213  * 412 'You must specify a key for a permission.': Returned if the permission definition that is supplied does not have a key defined.
214 214  * 412 'You cannot specify an inherited permission. Remove the permission instead.': Returned if the inherited flag of the permission definition is set to true.
215 215  )))
216 -|(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
217 +|=(% colspan="1" %)(% colspan="1" %)
217 217  (((
218 218  **DELETE**
219 219  )))|(% colspan="1" %)(% colspan="1" %)
... ... @@ -224,12 +224,11 @@
224 224  
225 225  * 404 'No permission with that key is defined for that user group.': Returned if there is no permission defined for the user group with that permission key.
226 226  )))
227 -
228 228  |=(% colspan="2" %)(% colspan="2" %)
229 229  (((
230 230  {{{communication_manager/api/resource/core/{core_server_id}/permissions/user/{user_id}}}}
231 231  )))
232 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
232 +|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
233 233  (((
234 234  **Description**
235 235  )))|(((
... ... @@ -245,18 +245,17 @@
245 245  
246 246  * 404 'No user exists with that id.': Returned if the provided user_id does not match a user in the system.
247 247  )))
248 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
248 +|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
249 249  (((
250 250  **GET**
251 251  )))|(((
252 252  Retrieves all permissions defined for the user.
253 253  )))
254 -
255 255  |=(% colspan="2" %)(% colspan="2" %)
256 256  (((
257 257  {{{communication_manager/api/resource/core/{core_server_id}/permissions/user/{user_id}/{key}}}}
258 258  )))
259 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
258 +|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
260 260  (((
261 261  **Description**
262 262  )))|(((
... ... @@ -276,7 +276,7 @@
276 276  
277 277  * 404 'No user exists with that id.': Returned if the provided user_id does not match a user in the system.
278 278  )))
279 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
278 +|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
280 280  (((
281 281  **GET**
282 282  )))|(((
... ... @@ -286,7 +286,7 @@
286 286  
287 287  * 404 'No permission with that key is defined for that user.': Returned if there is no permission defined for the user with that permission key.
288 288  )))
289 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
288 +|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
290 290  (((
291 291  **PUT**
292 292  )))|(((
... ... @@ -297,11 +297,10 @@
297 297  * 412 'You must specify a key for a permission.': Returned if the permission definition that is supplied does not have a key defined.
298 298  * 412 'You cannot specify an inherited permission. Remove the permission instead.': Returned if the inherited flag of the permission definition is set to true.
299 299  )))
300 -|(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
299 +|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
301 301  (((
302 302  **DELETE**
303 -)))|(% colspan="1" %)(% colspan="1" %)
304 -(((
302 +)))|(((
305 305  Clears the specific permission definition for the user.
306 306  
307 307  **Errors**:
... ... @@ -309,6 +309,8 @@
309 309  * 404 'No permission with that key is defined for that user.': Returned if there is no permission defined for the user with that permission key.
310 310  )))
311 311  
310 +
311 +
312 312  = Curl Examples =
313 313  
314 314  {{info}}