Get All Roles

Request

GET <REST API URL>/roles?fields=string&$skip=int&$top=int&query=string&orderBy=string

Parameter	Description
`fields`	Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.
`$skip`	Optional query parameter. Number of roles to skip before returning first entry of the page.
`$top`	Optional query parameter. Max number of roles to return in the page.
`query`	Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for Roles: has: permission — Roles with some permssions id: value — A role with the given id is: team — Roles that are team key: roleKey — A role with the given key name: roleName — A role with the given name permission: permission — Roles that includes the given permission permission(key: permissionKey, service: service) — Roles that includes the given permission permission(service: service) — Roles that have at least one permission from service
`orderBy`	Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: key, name

Response

Response Code	Meaning
200 OK	Successful request.
400 Bad Request	Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden	Requester has no access to the request.
404 Not Found	Requested resource wasn't found.
500 Internal Server Error	Failed to process request because of the server error. The response contains message describing the error.

Response body

page

{ "skip": int, "top": int, "total": int, "roles": [role, ...] }

Last modified: 19 July 2017