- URL:https://<roles-url>/getUsersWithinRole(POST only)
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.1
Description
You can use this operation to conveniently see all the user accounts to whom this role has been assigned.
Request parameters
| Parameter | Description |
|---|---|
| rolename | The name of the role. Example |
| filter | An optional filter to be applied to the resultant user set. |
| maxCount | The maximum number of results to return for this query. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample POST request for getUsersWithinRole that demonstrates how to get the first 20 users whose names begin with 'a' that are assigned the 'editor' role:
POST /webadaptor/admin/security/roles/getUsersWithinRole HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
rolename=editors&filter=&maxCount=20&f=jsonJSON Response syntax
{
"users": ["<user1>", "<user2>"],
"hasMore": <true|false>
}