Blue Prism API user permissions
The following tables list the Blue Prism user permissions required to successfully pass requests to different Blue Prism API endpoints. The Control Room plugin within Hub leverages the API, and therefore has the same permission set. The tables provides an overview of the available endpoints, requests, and required permissions with full details available in the Blue Prism reference. To access the API reference, see Blue Prism API.
For information on how to set user permissions, see Blue Prism user roles.
Permissions
Requests are grouped by the following categories:
- Dashboards
- Encryption schemes
- Resources
- Schedules
- Schedule sessions
- Session logs
- Sessions
- Work queues
Dashboards
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/dashboards |
This endpoint is not restricted by user permissions. |
Returns a list of work queue composition details. |
GET |
/api/v7/dashboards |
This endpoint is not restricted by user permissions. |
Returns a list of utilization details. |
GET |
/api/v7/dashboards/ |
This endpoint is not restricted by user permissions. |
Returns a list of resource utilization details for the specified date range. |
Encryption schemes
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/encryptionschemes |
This endpoint is not restricted by user permissions. |
Returns a list of encryption schemes. |
Resources
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/resources |
Requires at least one of the following Resource permissions:
|
Returns a list of resources in the environment. |
PUT |
/api/v7/resources/{resourceId} |
Requires the following Resource permission: |
Returns the specified resource. |
Schedules
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/schedules |
Requires at least one of the following Scheduler permissions:
|
Returns a list of schedules in the environment. |
GET |
/api/v7/schedules/logs |
Requires at least one of the following Scheduler permissions:
|
Returns all schedule logs. |
PUT |
/api/v7/schedules/{scheduleId} |
Requires all of the following Scheduler permissions to retire a schedule:
Requires all of the following Scheduler permissions to unretire a schedule:
|
Updates the specified schedule. |
GET |
/api/v7/schedules/ |
Requires at least one of the following Scheduler permissions:
|
Returns all logs for the specified schedule. |
GET |
/api/v7/schedules |
Requires at least one of the following Scheduler permissions:
|
Returns a list of tasks in the specified schedule. |
GET |
/api/v7/schedules/tasks/ |
Requires at least one of the following Scheduler permissions:
|
Returns a list of the scheduled sessions for a specified task. |
Schedule sessions
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
POST |
/api/v7/schedules/{scheduleId} |
Requires the following Scheduler permission:
|
Sets a schedule to run at a specific date and time. |
Session logs
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/sessions |
Requires at least one of the following Process Studio permissions:
And at least one of the following Resource permissions:
And the following System Manager permission:
|
Sets a schedule to run at a specific date and time. |
GET |
/api/v7/sessions/ |
Requires at least one of the following Process Studio permissions:
And at least one of the following Resource permissions:
And the following System Manager permission:
|
Returns all parameters for the specified session log. |
Sessions
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/sessions |
Requires at least one of the following Resources permissions:
And at least one of the following Process Studio permissions:
|
Returns a list of sessions in the environment. |
GET |
/api/v7/sessions/{sessionId} |
Requires at least one of the following Resources permissions:
And at least one of the following Process Studio permissions:
|
Returns details of the specified session. |
Work queues
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/workqueues |
Requires at least one of the following Control Room permissions:
|
Returns a list of work queues in the environment. |
POST |
/api/v7/workqueues |
Requires the following System Manager permission:
|
Creates a new work queue. |
GET |
/api/v7/workqueues/ |
Requires at least one of the following Control Room permissions:
|
Returns details of the specified work queue. |
DELETE |
/api/v7/workqueues/ |
Requires the following System Manager permission:
|
Deletes the specified work queue. |
PATCH |
/api/v7/workqueues/ |
Requires at least one of the following Control Room permissions:
And the following System Manager permission:
|
Modifies the specified work queue as described in the patch document. |
GET |
/api/v7/workqueues/ |
Requires at least one of the following Control Room permissions:
|
Returns items in the specified work queue. |
POST |
/api/v7/workqueues/ |
Requires at least one of the following Control Room permissions:
If accessing active queue items, at least one of the following Process Studio permissions are also required:
|
Adds items to a work queue. |
GET |
/api/v7/workqueues/items/ |
Requires at least one of the following Control Room permissions:
If accessing active queue items, at least one of the following Process Studio permissions are also required:
|
Returns details of the specified item in a work queue. |