List roles

List roles by project Id.

GET /api/management/projects/{projectId}/security/roles

Parameters

Name Parameter type Type Format Description
projectId path string The project identifier, e.g. "movieDb". Found in the project overview screen of the management console.
pageIndex query number integer The index of the page
pageSize query number integer The number of results per page. The default is 25.

Example request

Accept: application/json
GET: /api/management/projects/movieDb/security/roles?pageIndex=1&pageSize=5

Response message

HTTP status code Reason Response model
200 Success PagedList<Role>
401 Unauthorized Error
403 Forbidden Error
404 NotFound Error
500 InternalServerError Error

Validations

Project does not exist

Roles are project specific. If you attempt to list roles in a project which does not exist you will get the following response.

{
    "logId": "00000000-0000-0000-0000-000000000000",
    "message": "There are validation errors listing the roles",
    "data": [
        {
            "field": "projectId",
            "message": "The project does not exist"
        }
    ],
    "type": "Validation"
}

Insufficient permissions to list roles

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 the following response.

{
    "logId": "00000000-0000-0000-0000-000000000000",
    "message": "There are validation errors listing the roles",
    "data": [
        {
            "message": "Access denied"
        }
    ],
    "type": "Validation"
}

results matching ""

    No results matching ""