- URL:https://<groups-url>/getEnterpriseGroupsForUser(POST only)
- Required Capability:Default administrator role | Security and infrastructure privilege | Link to enterprise groups privilege
- Version Introduced:10.3
Description
This 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
| Parameter | Details |
|---|---|
| username | The name of the user account for which to return the assigned groups. Example |
| filter | An optional wildcard string that can be used to filter a search result to return specific groups. Example |
| maxCount | The maximum number of results the client is willing to accept. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample request URL for getEnterpriseGroupsForUser:
POST /webadaptor/portaladmin/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=jsonJSON Response example
{
"groups": [
"domain\Org_Bldg_A",
"domain\Org_Bldg_B",
"domain\Org_Bldg_C"
],
"hasMore": false
}