Skip To Content

Search Users

Description

This operation searches a specific user or a group of users from the user store. The size of the search result can be controlled with the maxCount parameter.

Request parameters

ParameterDescription
filter

A filter string to search the users.

Example

filter=john
maxCount

The maximum number of users that will be returned.

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 demonstrates how to return the first 20 users whose usernames start with 'john':


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

filter=john&maxCount=20&f=json

JSON Response syntax


{
  "users": [<user1>, <user2>],
  "hasMore": <true|false>
}

JSON Response example


{
  "users": [johnDoe, johnDern],
  "hasMore": false
}