Get Enterprise Groups for User

URL:
https://<root>/orgs/<orgID>/security/groups/getEnterpriseGroupsForUser
Methods:
POST
Required Capability:
Access allowed with either the "Links to organization-specific group" or "Security and infrastructure" privileges
Version Introduced:
10.9

Description

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

Request parameters

ParameterDetails

username

The name of the user account for which to return their 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 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 /context/admin/orgs/0123456789ABCDEF/security/groups/getEnterpriseGroupsForUser HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

username=domain\jdoe&filter=*bldg*&maxCount=10&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
{
  "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.