Get Users Within Enterprise Group

URL:
https://<root>/orgs/<orgID>/security/groups/getUsersWithinEnterpriseGroup
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 getUsersWithinEnterpriseGroup operation returns a list of users who are assigned to the enterprise group within the enterprise user and group stores. The filter parameter can be used to narrow search results.

Request parameters

ParameterDetails

groupName

Specifies the name of the enterprise group for which the user accounts need to be listed.

Example
Use dark colors for code blocksCopy
1
groupName=cartographers

filter

An optional parameter that can be used to filter search results to return specific users.

maxCount

Specifies 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 getUsersWithinEnterpriseGroup operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/orgs/0123456789ABCDEF/security/groups/getUsersWithinEnterpriseGroup HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

groupName=cartographers&filter=&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
9
10
11
12
13
14
15
16
{
  "users": [
    {
      "username": "domain\\aturing",
      "description": "CN=Alan Turing,OU=Users,OU=Development,OU=Departments,DC=domain,DC=com",
      "email": "aturing@domain.com",
      "fullname": "Alan Turing"
    },
    {
      "username": "domain\\jdoe",
      "description": "CN=John Doe,OU=Users,OU=Development,OU=Departments,DC=domain,DC=com",
      "email": "jdoe@domain.com",
      "fullname": "John Doe"
    }
  ]
}

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