Hub 2018.1 Help

Get All Default Roles of a Service

Request

GET <REST API URL>/services/{service id}/defaultroles?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional Lets you specify a subset of the fields to be returned. Use Fields Syntax to define the subset.
$skip Optional Lets you set a number of entries to skip before returning the first entry of the page.
$top Optional Lets you set the maximum number of entries to return in the page.
query

Optional Lets you filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the DefaultRoles, the following fields and tuples are supported:

has: permission — Default roles with some permissions

id: value — Service default role with the given ID

key: value — Default roles with the given key

name: value — Default roles with the given name

permission: permission — Default roles that include the given permission

has: permission — Roles with some permissions

id: value — Role with the given ID

key: roleKey — Role with the given key

name: roleName — 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 Optional Lets you order the returned results. See Sorting Syntax for details. DefaultRoles support ordering by the following fields: key, name, 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 a message that describes the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource was not found.
500 Internal Server Error Failed to process request because of the server error. The response contains a message that describes the error.

Response body

page

{ "skip": int, "top": int, "total": int, "defaultroles": [role, ...] }
Last modified: 5 April 2018