Search Enterprise Users

URL:
https://<root>/orgs/<orgID>/security/users/searchEnterpriseUsers
Methods:
POST
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
10.9

Description

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

Request parameters

ParameterDetails

filter

Keywords used to narrow the search.

Example
Use dark colors for code blocksCopy
1
filter=john

maxCount

The maximum number of records the client will accept.

Example
Use dark colors for code blocksCopy
1
maxCount=1000

f

The response format. The default 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 /context/admin/orgs/0123456789ABCDEF/security/users/searchEnterpriseUsers HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

filter=john&maxCount=1000&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

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\\jturing",
      "description": "Software Product Development",
      "fullname": "John Turing",
      "email": "jturing@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.