Search Roles

URL:
https://<root>/security/roles/search
Methods:
POST
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

The search operation searches for 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
Use dark colors for code blocksCopy
1
filter=editors

maxCount

The maximum size of the result size.

Example
Use dark colors for code blocksCopy
1
maxCount=20

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the search operation that seeks to return roles that begin with the name 'editors':

Use dark colors for code blocksCopy
1
2
3
4
5
6
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

Use dark colors for code blocksCopy
1
2
3
4
{
  "roles": [editors],
  "hasMore": false
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.