Search Enterprise Groups

URL:
https://<root>/security/groups/searchEnterpriseGroups
Methods:
POST
Required Capability:
Access allowed with either the "Security and Infrastructure" or "Link to Enterprise Groups" privileges
Version Introduced:
10.3

Description

The searchEnterpriseGroups operation searches groups in the configured enterprise group store. You can narrow down the search using the filter parameter.

Request parameters

ParameterDetails

filter

The optional parameter to narrow group search.

Example
Use dark colors for code blocksCopy
1
filter=carto

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 followig is a sample POST request for the searchEnterpriseGroups operation:

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

filter=carto&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
{
  "groups": [
    {
      "rolename": "<groupName1>"
    },
    {
      "rolename": "<groupName2>"
    },
    ...
  ],
  "hasMore": false
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "groups": [
    {
      "rolename": "domain\\carographers"
    }
  ],
  "hasMore": false
}

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