HTTP - Management
List roles
Created by Contensis product team, last modified by s.yearsley on 25 Sep 2020
List roles for a project.
GET/api/management/projects/{projectId}/security/roles
Parameters
| Name | Parameter type | Type | Format | Description | Example | Required |
|---|---|---|---|---|---|---|
| projectId | path | string | The project identifier found in the project overview screen of the management console | movieDb | true | |
| pageIndex | query | number | integer | The index of the page | false | |
| pageSize | query | number | integer | The number of results per page. The default is 25. | false |
Example
List roles with paging options
GET: /api/management/projects/movieDb/security/roles?pageIndex=1&pageSize=5Remarks
In order to list roles you must be a member of the "System Administrators" user group. If you do not have permission to list roles you will get a 403 Forbidden response.
Responses
| HTTP status code | Reason | Model |
|---|---|---|
| 200 | Success | PagedList<Role> |
| 401 | Unauthorized | Error |
| 403 | Forbidden | Error |
| 404 | Project not found | Error |
| 500 | Internal server error | Error |