Get Enterprise Groups For User

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

Description

The getEnterpriseGroupsForUser operation lists the groups assigned to a user account in the configured enterprise group store. You can use the filter parameter to narrow down the search results.

Request parameters

ParameterDetails

username

The name of the user account for which to return the assigned groups.

Example
Use dark colors for code blocksCopy
1
username=domain\jdoe

filter

An optional wildcard string that can be used to filter a search result to return specific groups.

Example
Use dark colors for code blocksCopy
1
filter=*bldg*

maxCount

The maximum number of results the client is willing to accept.

Example
Use dark colors for code blocksCopy
1
maxCount=10

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

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

username=domain\jdoe&filter=*bldg*&maxCount=10&f=json

JSON Response example

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

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