Hub 2.0 Help

Get All Permissions of a Role

Request

GET /roles/{role id}/permissions?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 the subset.
$skip Optional query parameter. Number of permissions to skip before returning the first entry in the page.
$top Optional query parameter. Maximum number of permissions 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 permissions:

id: value — A permission with the given key

key: permissionKey — A permission with the given key

name: permissionName — A permission with the given name

entityType: permissionEntityType — Permissions for the given entityType

operation: permissionOperation — Permissions for the given operation

service: service — Permissions provided by the given service

role: role — Persmissions of the given role

is: global — All global permissions

orderBy Order results. See Sorting Syntax for details. Permissions can be ordered by the following fields: key, name, entityType, operation

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, /* Requested number of permissions to skip before returning the first entry in the page */ "top": int, /* Requested maximum number of permissions to return in the page */ "total": int, /* Total number of permissions. Returned only if the total field is included as a value of the fields parameter in the query */ "permissions": [permission, ...] }
Last modified: 19 September 2016