Check Role's Machine Access
Given a list of machine identifiers and a list of role names (or IDs), return a list of MachineAccessResponses (one per each unique role ID/name and machine combo) indicating if each role has access to each machine.
| Verb | POST |
|---|---|
| Endpoint | {base-url}/roles/machine-access |
| Max Page Size | 50 |
Request Body
{
"requestFilter": {
"machineIdentifiers": ["3283"]
},
"routeFilter": {
"roleIdentifiers": [4]
}
}
Filters Honored
- RequestFilter
- machineIdentifiers
- PermissionsFilter
- roleIdentifiers
Returns
On Success
A list of role to machine mappings with a boolean indicating if that role can access that machine.
Response Body
[
{
"roleName": null, // never populated on this response
"roleId": 4,
"prose": "PROSE0200003283", // will be null if you specified an id for this machine
"machineId": 3283, // will always be present
"canAccess": true
}
]
On Error
| HTTP Code | Error Code | Definition |
|---|---|---|
| 403 | DATA_ACCESS_VIOLATION | One or more of the specified roleIdentifiers belong to an organization you do not have access to. |
| 422 | MISSING_REQUIRED_DATA | No machine identifiers were provided. |