Permissions

Permissions enable users to perform a particular function or task within a specific area of the product. For example, a user might have permission within the General Ledger to view financial reports but not to create, edit, or delete them.

A permission specifies a module, such as accountsPayable, a specific permission name, such as vendors, and the allowed access rights for that permission, such as list, view, add, and edit.

You use role-permission-assignment objects to assign permissions to roles.

List permissions

get/objects/company-config/permission

Returns a collection with a key, ID, and link for each permission. This operation is mostly for use in testing; use the query service to find permissions that meet certain criteria and specify the properties that are returned.

Permissions and other requirements
SubscriptionAdministration
ConfigurationRole-based
User typeBusiness user with admin privileges
PermissionsUsers - List, View, Permissions
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.



Permissions and other requirements



SubscriptionAdministration


ConfigurationRole-based


User typeBusiness user with admin privileges


PermissionsUsers - List, View, Permissions







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


 
 Example:  102
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
    }
}