Role permission assignments

A role permission assignment shows a single permission and set of access rights for a role. It is an owned object of a role object. You create, update, and delete role permission assignment objects through operations on the owning role.

Roles are used in companies that have role-based permissions. Companies with user-based permissions do not use roles.

List role permission assignments

get/objects/company-config/role-permission-assignment

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

Permissions and other requirements
SubscriptionAdministration
ConfigurationRole-based
User typeBusiness user with admin privileges
PermissionsList, View Users
SecurityOAuth2
Responses
200

OK

400

Bad Request

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



Permissions and other requirements



SubscriptionAdministration


ConfigurationRole-based


User typeBusiness user with admin privileges


PermissionsList, View Users







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


 
 Example:  1748
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1748",
    • "id": "1748",
    • "role": {
      • "key": "528",
      • "id": "::SYS::Multi Entity Shared-ROLE-FOR - EMP4-US",
      • "href": "/objects/company-config/role/528"
      },
    • "permission": {
      • "key": "3295",
      • "id": "3295",
      • "name": "coverLetters",
      • "module": "company",
      • "href": "/objects/company-config/permission/3295"
      },
    • "accessRights": [
      • "list",
      • "readonly",
      • "add",
      • "modify",
      • "delete"
      ],
    • "audit": {
      • "createdDateTime": "2023-08-18T09:43:13Z",
      • "modifiedDateTime": "2023-08-18T09:43:13Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/company-config/role-permission-assignment/1748"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query role permission assignments
post/services/core/query
Use the query service to find role permission assignments 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
    }
}