Skip to main content
Browse Documentation
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

NameParameter typeTypeFormatDescriptionExampleRequired
projectIdpathstringThe project identifier found in the project overview screen of the management consolemovieDbtrue
pageIndexquerynumberintegerThe index of the pagefalse
pageSizequerynumberintegerThe 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=5

Remarks

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 codeReasonModel
200SuccessPagedList<Role>
401UnauthorizedError
403ForbiddenError
404Project not foundError
500Internal server errorError