Get Users Within Enterprise Group

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

Description

The getUsersWithinEnterpriseGroup operation returns the users that are currently assigned to the enterprise group within the enterprise user and group store. You can use the filter parameter to narrow down the user search.

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

(Optional)

Narrows down the user search.

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 response 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 /webadaptor/portaladmin/security/groups/getUsersWithinEnterpriseGroup HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

groupName=cartographers&filter=&maxCount=10&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "users": [
    {
      "username": "<username1>",
      "description": "<description>",
      "email": "<email>",
      "fullname": "<full name>"
    },
    ...
  ]
  "hasMore": <true|false>
}

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.