Changes for page Permissions Configuration

Last modified by colinw on 2021/09/10 23:34

From 8.1 to 9.1 From 16.2 to 16.3

From version 9.1

edited by colinw
on 2014/11/10 22:21

Change comment: There is no comment for this version

To version 16.2

edited by colinw
on 2021/09/10 22:57

Change comment: Update document after refactoring.

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Parent

...	...	@@ -1,0 +1,1 @@
	1	+ISYMDEV.iSymphony Developer Documentation.REST API Documentation.Configuration API.WebHome

Content

@@ -1,22 +1,65 @@
--==== **//On this page~://** ====
++{{layout}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
++{{warning}}
++This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
++{{/warning}}
++{{info}}
++The information on this page applies to **iSymphony 3.1+**.
++{{/info}}
++= (% style="color: rgb(0,0,0);" %)Description(%%) =
--{{toc maxLevel="2" indent="1"/}}
++The Permissions resource provides access to query and define permissions for iSymphony. See the reference information below for details about the REST interactions used to define permissions. The rest of this description is provided to make it easier to understand the various interactions that go into the permission system in iSymphony.
++{{/layout-cell}}
--= Description =
++{{layout-cell}}
++{{panel title="On this page:"}}
--The Permissions resource provides access to query and define permissions for iSymphony.
++{{toc maxLevel="2" indent="1"/}}
++{{/panel}}
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++=== Overview ===
++
++In version 3.0 and previous of iSymphony, permissions were defined for 'permissible' objects in the system - each object that could be controlled via permissions (extensions, queues, other users, etc) would store a list of the users allowed to perform actions on it, and which actions each was allowed to perform. Beginning in version 3.1 of iSymphony, the situation has been reversed, to make it easier to administer permissions and hopefully less confusing. Permissions are defined for each user or user group in the system, in a cascading manner. They are evaluated in order of decreasing specificity, and in the case of a conflicting tie, the action is allowed. This must be considered when using the REST system to define permissions. See the documentation for permissions for more details.
++
++=== Defaults ===
++
++By default, all users in the system are allowed to perform all actions. Therefore, if a specific permission key has not been defined for a user (either on the user itself, or one of the groups it is a member of), that action should be considered allowed. When defining a permission, the default policy is also allowed, unless the allowed flag is set to false.
++
++=== **Exceptions** ===
++
++The heart of the permission system lies in the exceptions to the rules. This allows for powerful combinations to be achieved. Generally, the objects defined by their UUIDs in the exceptions field will be allowed to perform an action if the allowed flag is false, and prevented from performing that action if the allowed flag is true. That is, they will follow the opposite of the general policy for that definition.
++
++=== Special Values ===
++
++There are a few special predefined values that are used by the permission system. They are:
++
++* All Users Group: The all users group is hard-coded into iSymphony to contain all users. You can use this to set global permissions on the clients. The UUID for the 'All Users' group is 21d97061-ff6a-11e1-a21f-0800200c9a66.
++* 'Owned' permission target: In many cases, an administrator may want to defined that users only have access to their "own" objects: their user, their extensions, their phone numbers, etc. In this case, setting the permission to 'Deny', with the special exception df41edec-2707-46eb-8b8f-146b01d9b29e will only give users access to their own objects.
++
  = Root Resource Paths =
  {{code}}
  communication_manager/api/resource/core/{core_server_id}/permissions
--communication_manager/api/resource/core/getBySlug/{core_server_slug}/permissions
  {{/code}}
  = JSON Representation =
++{{code title="Core Server Permissions Enabled" language="js"}}
++{
++    "permissionsEnabled": false
++}
++{{/code}}
++
++Note: the above object is only used to enable or disable permissions. See the page on the core server configuration itself to query the status of the permissions.
++
  {{code title="PermissionConfig" language="js"}}
      {
          "key": "cellPhoneOriginateTo",
@@ -77,14 +77,35 @@
  |=(% colspan="2" %)(% colspan="2" %)
  (((
--{{{communication_manager/api/resource/core/{core_server_id}/permissions/userGroup/{user_group_id}}}}
--
--{{{communication_manager/api/resource/core/getBySlug/{core_server_slug}/permissions/userGroup/{user_group_id}}}}
++communication_manager/api/resource/core/{core_server_id}/permissions
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
--(((
++|=(((
  **Description**
  )))|(((
++Specifies whether permissions should be enabled or disabled for the entire core server. When disabled, no permission checks will be performed, so the rest of the settings specified in the permissions system will have no effect. Note that you must have a supported license installed to enable permissions.
++
++**Parameters**:
++
++* core_server_id: The UUID of the core server
++
++**Errors**:
++
++* 500 'Your license does not support permissions.': Returned if you do not have a license installed, or if your license does not support permissions.
++)))
++|=(((
++PUT
++)))|(((
++Sets whether permissions are enabled or disabled globally on the core server.
++)))
++|=(% colspan="2" %)(% colspan="2" %)
++(((
++{{{communication_manager/api/resource/core/{core_server_id}/permissions/userGroup/{user_group_id}}}}
++)))
++|=(% colspan="1" %)(% colspan="1" %)
++(((
++Description
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Retrieves permissions for the user group identified by the {user_group_id} path parameter.
  **Parameters**:
@@ -97,21 +97,18 @@
  * 404 'No user group exists with that id.': Returned if the provided user_group_id does not match a user group in the system.
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% colspan="1" %)(% colspan="1" %)
  (((
--**GET**
--)))|(((
++GET
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Retrieves all permissions defined for the user group.
  )))
--
  |=(% colspan="2" %)(% colspan="2" %)
  (((
  {{{communication_manager/api/resource/core/{core_server_id}/permissions/userGroup/{user_group_id}/{key}}}}
--
--{{{communication_manager/api/resource/core/getBySlug/{core_server_slug}/permissions/userGroup/{user_group_id}/{key}}}}
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
--(((
++|=(((
  **Description**
  )))|(((
  Retrieves or updates a specific permission for a user group.
@@ -130,10 +130,11 @@
  * 404 'No user group exists with that id.': Returned if the provided user_group_id does not match a user group in the system.
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% colspan="1" %)(% colspan="1" %)
  (((
  **GET**
--)))|(((
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Retrieves a specific permission for the user group.
  **Errors**:
@@ -140,10 +140,11 @@
  * 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.
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% colspan="1" %)(% colspan="1" %)
  (((
  **PUT**
--)))|(((
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  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.
  **Errors**:
@@ -151,7 +151,7 @@
  * 412 'You must specify a key for a permission.': Returned if the permission definition that is supplied does not have a key defined.
  * 412 'You cannot specify an inherited permission. Remove the permission instead.': Returned if the inherited flag of the permission definition is set to true.
  )))
--|(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
++|=(% colspan="1" %)(% colspan="1" %)
  (((
  **DELETE**
  )))|(% colspan="1" %)(% colspan="1" %)
@@ -162,14 +162,11 @@
  * 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.
  )))
--
  |=(% colspan="2" %)(% colspan="2" %)
  (((
  {{{communication_manager/api/resource/core/{core_server_id}/permissions/user/{user_id}}}}
--
--{{{communication_manager/api/resource/core/getBySlug/{core_server_slug}/permissions/user/{user_id}}}}
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
  (((
  **Description**
  )))|(((
@@ -185,20 +185,17 @@
  * 404 'No user exists with that id.': Returned if the provided user_id does not match a user in the system.
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
  (((
  **GET**
  )))|(((
  Retrieves all permissions defined for the user.
  )))
--
  |=(% colspan="2" %)(% colspan="2" %)
  (((
  {{{communication_manager/api/resource/core/{core_server_id}/permissions/user/{user_id}/{key}}}}
--
--{{{communication_manager/api/resource/core/getBySlug/{core_server_slug}/permissions/user/{user_id}/{key}}}}
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
  (((
  **Description**
  )))|(((
@@ -218,7 +218,7 @@
  * 404 'No user exists with that id.': Returned if the provided user_id does not match a user in the system.
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
  (((
  **GET**
  )))|(((
@@ -228,7 +228,7 @@
  * 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.
  )))
--|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
++|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
  (((
  **PUT**
  )))|(((
@@ -239,11 +239,10 @@
  * 412 'You must specify a key for a permission.': Returned if the permission definition that is supplied does not have a key defined.
  * 412 'You cannot specify an inherited permission. Remove the permission instead.': Returned if the inherited flag of the permission definition is set to true.
  )))
--|(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
++|=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
  (((
  **DELETE**
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
++)))|(((
  Clears the specific permission definition for the user.
  **Errors**:
@@ -251,42 +251,39 @@
  * 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.
  )))
--= Sub/Child Resource Paths =
++
--|=(% colspan="2" %)(% colspan="2" %)
--(((
--{{{path}}}
--)))
--|(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
--(((
--**Description**
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--description
--)))
--
  = Curl Examples =
--=== Get ===
++{{info}}
++The server ID in the below examples is 9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7. You will need to change this to the appropriate ID for your installation, as well as change other IDs.
++{{/info}}
++=== (% style="color: rgb(0,0,0);" %)Get all defined permissions for the 'All Users' group(%%) ===
++
  {{code language="bash"}}
--
++curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" https://127.0.0.1:55050/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7/permissions/userGroup/21d97061-ff6a-11e1-a21f-0800200c9a66
  {{/code}}
--=== (% style="color: rgb(0,0,0);" %)Update(%%) ===
++=== Get all defined permissions for a specific user ===
--{{code language="bash"}}
--
++{{code}}
++curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" https://127.0.0.1:55050/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7/permissions/user/8a026a93-3201-4554-b993-32576a3b8ea5
  {{/code}}
--=== Add ===
++=== (% style="color: rgb(0,0,0);" %)Deny the 'passwordChange' permission for the above user(%%) ===
  {{code language="bash"}}
--
++curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X PUT -d '{"key":"passwordChange","allowed":"false"}' https://127.0.0.1:55050/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7/permissions/user/8a026a93-3201-4554-b993-32576a3b8ea5/passwordChange
  {{/code}}
--=== Delete ===
++=== Remove the 'passwordChange' permission for the above user ===
++Note: this will not prevent the user from changing their password. It will cause the user to inherit the permission of any user groups they are a part of.
++
  {{code language="bash"}}
--
++curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X DELETE https://127.0.0.1:55050/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7/permissions/user/8a026a93-3201-4554-b993-32576a3b8ea5/passwordChange
  {{/code}}
++{{/layout-cell}}
++{{/layout-section}}
++{{/layout}}

Changes for page Permissions Configuration

Summary

Details

Search

Navigation