Skip To Content

Search Roles

Description

This operation searches a specific role or a group of roles from the role store. The size of the search results can be controlled with the maxCount parameter.

Request parameters

ParameterDescription
filter

A filter string to search the roles.

Example

filter=editors
maxCount

The maximum size of the result size.

Example

maxCount=20
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample POST request for search that demonstrate how to return roles that begin with the name 'editors':


POST /webadaptor/admin/security/roles/search HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

filter=editors&maxCount=20&f=json

JSON Response example


{
  "roles": [editors],
  "hasMore": false
}