- 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 get
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
Parameter | Details |
---|---|
| Specifies the name of the enterprise group for which the user accounts need to be listed. Example
|
| An optional parameter that can be used to filter search results to return specific users. |
| Specifies the maximum number of results the client is willing to accept. Example
|
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the get
operation:
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
{
"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"
}
]
}