Hub Help

Get All Roles

Request

GET /roles?fields=fieldsExpression&$skip=count&$top=count&query=value
Parameter Description
fields Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.
$skipOptional query parameter. Number of roles to skip before returning first entry of the page.
$topOptional 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 specific permissions

id: {text} — A role with the given id

is: {team} — Roles that are team

key: {role name} — A role with the given key

name: {role name} — A role with the given name

permission: {permission key or name} — Roles that includes the given permission

permission(key: {permission key}, service: {service id, name or home URL}) — Roles that includes the given permission

orderByOrder results. See Sorting Syntax for details. Roles can be ordered by the following fields: 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

{ "roles": [{ "id": "string", "aliasIds": ["string", ...], "url": "string", "key": "string", "name": "string", "description": "string", "teamRole": Boolean, "permissions": [{permission}, ...] }, ...] }
Last modified: 22 May 2015