Get Users Within Role

URL:
https://<root>/security/roles/getUsersWithinRole
Methods:
POST
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

Description

The getUsersWithinRole operation returns a list of all user accounts to whom a role has been assigned.

Request parameters

ParameterDescription

rolename

The name of the role.

Example
Use dark colors for code blocksCopy
1
rolename=editors

filter

An optional filter to be applied to the resultant user set.

maxCount

The maximum number of results to return for this query.

Example
Use dark colors for code blocksCopy
1
maxCount=20

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 getUsersWithinRole operation that seeks to return the first 20 users whose names begin with 'a' that are assigned the 'editor' role:

Use dark colors for code blocksCopy
1
2
3
4
5
6
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=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
{
  "users": ["<user1>", "<user2>"],
  "hasMore": <true|false>
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.