Skip To Content

Get Users Within Enterprise Group

Description

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

Note:

This operation returns nested users if the security configuration has been configured to support nested users and groups.

Request parameters

ParameterDetails
groupName

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

Example

groupName=cartographers
filter

(Optional)

Narrows down the user search.

maxCount

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

Example

maxCount=10
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample request URL for getUsersWithinEnterpriseGroup:


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=json

JSON Response syntax


{
  "users": [
    {
      "username": "<username1>",
      "description": "<description>",
      "email": "<email>",
      "fullname": "<full name>"
    },
    ...
  ]
  "hasMore": <true|false>
}

JSON Response example

Note:

If this operation is being used to search in an Active Directory group that has more than 1,000 users, only the first 1,000 users will be returned by this operation. It is recommended that users be searched for individually in these instances.


{
  "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"
    }
  ]
}