Role permission assignments

This object shows permission-to-role relationships and access rights for each specific permission.

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.

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.


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


 
 Example:  47
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "177748",
    • "id": "177748",
    • "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/177748"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a role permission assignment
delete/objects/company-config/role-permission-assignment/{key}
Deletes a role permission assignment.


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


 
 Example:  47
Responses 
204
No Content


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
    }
}
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


Request samples