Permissions

Each specific role is associated with particular modules, and each module contains multiple permissions. When assigning a permission to a specific role, there is validation that ensures that the specified permissions are allowed for the role.

List permissions

get/objects/company-config/permission

Returns a collection with a key, ID, and link for each permission.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/permission/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/company-config/permission/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a permission
get/objects/company-config/permission/{key}
Returns detailed information for a specified permission.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the permission.


 
 Example:  152
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "module": "myAccounting",
    • "name": "switchToMyAccounting",
    • "permissionGroup": "activitiesAndLists",
    • "allowedAccessRights": [
      • "list"
      ],
    • "href": "/objects/company-config/permission/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query permissions
post/services/core/query
Use the query service to find permissions that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}