Search Enterprise Users

URL:
https://<root>/security/users/searchEnterpriseUsers
Methods:
POST
Required Capability:
Access allowed with either the "Security and Infrastructure" or "Add" privileges
Version Introduced:
10.3

Description

The searchEnterpriseUsers operation searches users in the configured enterprise user store. You can narrow down the search using the filter parameter.

Request parameters

ParameterDetails

filter

An optional parameter to narrow the user search.

Example
Use dark colors for code blocksCopy
1
filter=john

maxCount

The maximum number of records that the client is willing to accept.

Example
Use dark colors for code blocksCopy
1
maxCount=1000

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 searchEnterpriseUsers operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/portaladmin/security/users/searchEnterpriseUsers HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

filter=john&maxCount=1000&f=json

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "users": [
    {
      "username": "<username>",
      "description": "<description>",
      "fullname": "<fullname>",
      "email": "<email>"
    },
    ...
  ]
  "hasMore": <true|false>
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "users": [
    {
      "username": "domain\\jdoe0001",
      "description": "CN=jdoe,OU=Users,OU=Support Group,OU=Departments,DC=domain,DC=com",
      "fullname": "John Doe",
      "email": "jdoe@domain.com"
    },
    {
      "username": "DOMAIN\\aturing",
      "description": "Software Product Development",
      "fullname": "Alan Turing",
      "email": "aturing@email.com"
    }
  ],
  "hasMore": false
}

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