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:
- Calendars
- Dashboards
- Encryption schemes
- Environment variables
- Health
- Licenses
- Processes
- Resources
- Schedule logs
- Schedules
- Schedule sessions
- Session logs
- Sessions
- Time zones
- Users
- Work queues
- Work queue groups
Calendars
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/calendars |
Requires the following System Manager permissions:
|
Returns a list of calendars. |
POST |
/api/v7/calendars |
Requires the following System Manager permissions:
|
Creates a calendar. |
GET |
/api/v7/calendars/{calendarId} |
Requires the following System Manager permissions:
|
Returns the specified calendar. |
DELETE |
/api/v7/calendars/{calendarId} |
Requires the following System Manager permissions:
|
Deletes the specified calendar. |
PATCH |
/api/v7/calendars/{calendarId} |
Requires the following System Manager permissions:
|
Updates the specified calendar. |
POST |
/api/v7/calendars/{calendarId}/clones |
Requires the following System Manager permissions:
|
Creates a clone of the specified calendar. |
GET |
/api/calendars/{calendarId}/otherHolidays |
Requires the following System Manager permissions:
|
Returns other holidays for the specified calendar. |
POST |
/api/calendars/{calendarId}/otherHolidays/batch |
Requires the following System Manager permissions:
|
Creates other holidays for the specified calendar. |
DELETE |
/api/calendars/{calendarId}/otherHolidays/batch |
Requires the following System Manager permissions:
|
Deletes any configured other holidays for the specified calendar. |
GET |
/api/v7/calendars/{calendarId}/references |
Requires the following System Manager permissions:
|
Returns all processes and objects that use the specified calendar. |
GET |
/api/v7/holidayRegions |
Requires the following System Manager permissions:
|
Returns a list of holiday regions. |
GET |
/api/v7/holidayRegions/{holidayRegionId}/publicHolidays |
Requires the following System Manager permissions:
|
Returns a list of public holidays for the specified region. |
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. |
GET |
/api/v7/dashboards/ |
Requires the following Resource permissions:
And at least one of the following Process Alerts permissions:
Or the following System Manager permission:
|
Return current active licenses, and associated limits and usages. |
GET |
/api/v7/dashboards/ |
Requires the following System Manager permissions:
|
Returns current active licenses and their entitlements. |
Encryption schemes
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/encryptionschemes |
Requires the following System Manager permission:
|
Returns a list of encryption schemes. |
Environment variables
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/environmentvariables |
Requires the following System Manager permissions:
|
Returns a list of environment variables. |
POST |
/api/v7/environmentvariables |
Requires at least one of the following System Manager permissions:
|
Creates an environment variable. |
PATCH |
/api/v7/environmentvariables/{environmentVariableId} |
Requires at least one of the following System Manager permissions:
|
Updates the specified environment variable. |
DELETE |
/api/v7/environmentvariables/{environmentVariableId} |
Requires at least one of the following System Manager permissions:
|
Deletes the specified environment variable. |
GET |
/api/v7/environmentvariables/{environmentVariableId}/references |
Requires at least one of the following System Manager permissions:
|
Returns all processes and objects that use the specified environment variable. |
Health
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/health |
This endpoint is not restricted by user permissions. |
Returns the health of the API dependencies, for example, the database. |
Licenses
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/licenses |
Requires the following System Manager permissions:
|
Returns a list of licenses. |
POST |
/api/v7/licenses |
Requires the following System Manager permissions:
|
Creates a new license. |
DELETE |
/api/v7/licenses/{licenseId} |
Requires the following System Manager permissions:
|
Deletes the specified license. |
Processes
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/processes |
Requires at least one of the following Process Studio permissions:
|
Returns a list of processes. |
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. |
GET |
/api/v7/resources/pools |
Requires at least one of the following Resource permissions:
|
Return a list of resource pools. |
Schedule logs
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/scheduleLogs |
Requires at least one of the following Scheduler permissions:
|
Returns all schedule logs. |
GET |
/api/v7/scheduleLogs/{scheduleId} |
Requires at least one of the following Scheduler permissions:
|
Returns all logs for the specified schedule. |
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. |
POST |
/api/v7/schedules |
Requires the following Scheduler permissions:
|
Creates a new schedule definition. |
GET |
/api/v7/schedules/logs |
Requires at least one of the following Scheduler permissions:
|
Returns all schedule logs. This endpoint will be deprecated in a future release, and is replaced by the /api/v7/scheduleLogs endpoint. |
GET |
/api/v7/schedules/{scheduleId} |
Requires at least one of the following Scheduler permissions:
|
Returns the requested schedule summary. |
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. |
DELETE |
/api/v7/schedules/{scheduleId} |
Requires the following Scheduler permissions:
|
Deletes the specified schedule. |
POST |
/api/v7/schedules/{scheduleId}/clones |
Requires the following Scheduler permissions:
|
Creates a clone of the specified schedule. |
GET |
/api/v7/schedules/ |
Requires at least one of the following Scheduler permissions:
|
Returns all logs for the specified schedule. This endpoint will be deprecated in a future release, and is replaced by the api/v7/scheduleLogs/{scheduleId} endpoint. |
GET |
/api/v7/schedules |
Requires at least one of the following Scheduler permissions:
|
Returns a list of tasks in the specified schedule. |
POST |
/api/v7/schedules |
Requires at least one of the following Scheduler permissions:
|
Creates a task for the specified schedule. |
GET |
/api/v7/schedules |
Requires at least one of the following Scheduler permissions:
|
Returns a specified scheduled task. |
PUT |
/api/v7/schedules |
Requires the following Scheduler permissions:
|
Updates a specified scheduled task. |
DELETE |
/api/v7/schedules |
Requires the following Scheduler permissions:
|
Deletes a specified task in 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. This endpoint will be deprecated in a future release, and is replaced by the /api/v7/schedules/{scheduleId}/tasks/{taskId}/sessions endpoint. |
GET |
/api/v7/schedules/{scheduleId} |
Requires at least one of the following Scheduler permissions:
|
Returns a list of the scheduled sessions for a specified task. |
POST |
/api/v7/schedules/{scheduleId} |
Requires at least one of the following Process Studio permissions:
And at least one of the following Resource permissions:
And the following Scheduler permission:
|
Creates a scheduled session for the specified task. |
GET |
/api/v7/schedules |
Requires at least one of the following Scheduler permissions:
|
Returns start-up parameters. |
PUT |
/api/v7/schedules |
Requires the following Scheduler permissions:
|
Updates start-up parameters. |
DELETE |
/api/v7/schedules |
Requires the following Scheduler permissions:
|
Deletes the specified scheduled task session. |
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. This endpoint will be deprecated in a future release, and is replaced by the api/v7/schedules/{scheduleId}/runs endpoint. |
DELETE |
/api/v7/schedules/{scheduleId} |
Requires the following Scheduler permission:
|
Requests the specified schedule to stop. This endpoint will be deprecated in a future release, and is replaced by the /api/v7/schedules/{scheduleId}/runs/active endpoint. |
POST |
/api/v7/schedules/{scheduleId}/runs |
Requires the following Scheduler permission:
|
Creates a session for the schedule to be run at a specified date and time. |
DELETE |
/api/v7/schedules/{scheduleId}/runs/active |
Requires the following Scheduler permission:
|
Requests the specified schedule to stop. |
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. |
POST |
/api/v7/sessions |
Requires the following Resource permission:
And at least one of the following Process Studio permissions:
|
Creates new session(s) for the specified resource ID and process IDs. |
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. |
PATCH |
/api/v7/sessions/{sessionId} |
Requires the following Resource permission:
And at least one of the following Process Studio permissions:
|
Updates the specified session. |
DELETE |
/api/v7/sessions/{sessionId} |
Requires the following Resource permission:
And at least one of the following Process Studio permissions:
|
Deletes a specified pending session. |
GET |
/api/v7/sessions |
Requires at least one of the following Resources permissions:
And at least one of the following Process Studio permissions:
|
Returns start-up parameters for the specified session. |
PUT |
/api/v7/sessions |
Requires the following Resource permission:
And at least one of the following Process Studio permissions:
|
Updates start-up parameters for the specified session. |
Time zones
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/timezones |
This endpoint is not restricted by user permissions. |
Returns a list of time zones. |
Users
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
GET |
/api/v7/user/permissions |
This endpoint is not restricted by user permissions. |
Returns the permissions enabled for the currently authenticated user. |
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 the following System Manager permission:
|
Returns all processes and objects that use the specified work queue. |
GET |
/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 is also required:
And the following Resource permission:
|
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. This endpoint will be deprecated in a future release, and is replaced by the /api/v7/workqueues/{workQueueId}/items/batch endpoint. |
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:
|
Creates multiple work queue items. |
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. This endpoint will be deprecated in a future release, and is replaced by the /api/v7/workqueues/ |
GET |
/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:
|
Returns details of the specified item in a work queue. |
GET |
/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:
|
Returns all attempts for the specified work queue item. |
POST |
/api/v7/workqueues/ |
Requires at least one of the following Control Room permissions:
|
Creates a new work queue item attempt by forcing an item to retry. |
PATCH |
/api/v7/workqueues/ |
Requires at least one of the following Control Room permissions:
|
Modifies the work queue item as described in the patch document. This request can be used to update a work queue item's status, or to defer a pending item. |
DELETE |
/api/v7/workqueues/ |
Requires at least one of the following Control Room permissions:
|
Deletes a worked queue item. |
Work queue groups
Request |
Endpoint |
Required user permission |
Response |
---|---|---|---|
POST |
/api/v7/workqueuegroup |
Requires the following System Manager permission:
|
Creates a work queue group. |
GET |
/api/v7/workqueuegroups/{workQueueGroupId} |
Requires the following System Manager permission:
|
Returns details of the specified work queue group. |
PATCH |
/api/v7/workqueuegroups/{workQueueGroupId} |
Requires the following System Manager permission:
|
Modifies the work queue group as described in the patch document. |
DELETE |
/api/v7/workqueuegroups/{workQueueGroupId} |
Requires the following System Manager permission:
|
Deletes a work queue group. |
GET |
/api/v7/workqueuegroups/{workQueueGroupId}/items |
Requires the following System Manager permission:
|
Returns a list of work queue group items. |
GET |
/api/v7/workqueuegroups/{workQueueGroupId}/child-groups |
Requires the following System Manager permission:
|
Returns details of child groups of the specified work queue group. |