Search Enterprise Groups

• URL:https://<groups-url>/searchEnterpriseGroups(POST only)
  
• Required Capability:Default administrator role | Security and infrastructure privilege | Link to enterprise groups privilege
• Related Resources:Search Enterprise Users
• Version Introduced:10.3

Description

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

Note:

This operation only works when an enterprise group store such as Windows domain or LDAP has been configured using the Update Identity Store operation.

Request parameters

Parameter	Details
filter	The optional parameter to narrow group search. Example filter=carto
maxCount	The maximum number of records that the client is willing to accept. Example maxCount=1000
f	The response format. The default response format is html. Values: html | json | pjson

Example usage

Below is a sample request URL for searchEnterpriseGroups:

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

{
  "groups": [
    {
      "rolename": "<groupName1>"
    },
    {
      "rolename": "<groupName2>"
    },
    ...
  ],
  "hasMore": false
}

JSON Response example

{
  "groups": [
    {
      "rolename": "domain\\carographers"
    }
  ],
  "hasMore": false
}