Permissions Configuration
On this page:
Description
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.
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. There are a few special cases.
Root Resource Paths
communication_manager/api/resource/core/getBySlug/{core_server_slug}/permissions
JSON Representation
"key": "cellPhoneOriginateTo",
"allowed": false,
"exceptions": [
"df41edec-2707-46eb-8b8f-146b01d9b29e"
],
"inherited": false
}
Property | Type | Description |
|---|---|---|
key | String | The key used for this permission configuration. |
allowed | Boolean | Whether the action should be generally allowed or not. |
exceptions | Array of Strings (UUID) | The objects defined in the exceptions will be granted or denied access as exceptions to the general rule. |
inherited | Boolean | Used internally. Should never be true when using the REST system. |
Resource Paths
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} | |
|---|---|
Description | Retrieves permissions for the user group identified by the {user_group_id} path parameter. Parameters:
Errors:
|
GET | Retrieves all permissions defined for the user group. |
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} | |
|---|---|
Description | Retrieves or updates a specific permission for a user group. Parameters:
Errors:
|
GET | Retrieves a specific permission for the user group. Errors:
|
PUT | 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:
|
DELETE | Clears the specific permission definition for the user group. Errors:
|
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} | |
|---|---|
Description | Retrieves permissions for the user group identified by the {user_id} path parameter. Parameters:
Errors:
|
GET | Retrieves all permissions defined for the user. |
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} | |
|---|---|
Description | Retrieves or updates a specific permission for a user group. Parameters:
Errors:
|
GET | Retrieves a specific permission for the user. Errors:
|
PUT | Sets the permission definition for the user with the specified key. The key defined in the permission definition body must match the key used in the URL. Errors:
|
DELETE | Clears the specific permission definition for the user. Errors:
|