Roles API
Overview
The Roles API returns the list of roles and permissions available in Arctera Surveillance.
Endpoint URL
POST https://<Reporting endpoint Base URL>/odata/roles
Sample request
GET https://<Reporting endpoint Base URL>/odata/roles
Sample response
Status code: 200 OK
Parameters/Filters
Specify the following filters to obtain refined and selective results from this report.
| Name | Type | Description |
|---|---|---|
| Departments | Optional | Specifies IDs of the departments to which roles belongs to. |
| Limitations: | ||
| The Roles API can pass a maximum of 100 Departments IDs as input. | ||
| Data Type: JSON array of integers 'id'(identifier fields) that is Departments. | ||
| Scopes | Optional | Specifies the scope of the roles. Possible values are: 160 for application-level roles and 161 for department-level roles. |
| Data Type: JSON array of integers 'id'(identifier fields) that is Scopes. |
Sample request with filters
POST https://<Reporting endpoint Base URL>/odata/Roles
{
"Departments": [5,6],
"Scopes" :[161]
}
Sample response with filters
Status code: 200 OK
Supported OData Filters
Responses
See Responses.