- URL:
- https://<root>/security/groups/getUsersWithinEnterpriseGroup
- Methods:
GET- Version Introduced:
- 10.3
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The get 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
| Parameter | Details |
|---|---|
| Specifies the name of the enterprise group for which the user accounts need to be listed. Example |
(Optional) | Narrows down the user search. |
| Specifies the maximum number of results the client is willing to accept. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the get operation:
POST /<context>/portaladmin/security/groups/getUsersWithinEnterpriseGroup HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
groupName=cartographers&filter=&maxCount=10&f=pjsonJSON Response syntax
{
"users": [
{
"username": "<username1>",
"description": "<description>",
"email": "<email>",
"fullname": "<full name>"
},
...
]
"hasMore": <true|false>
}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"
}
]
}