Returns a paginated list of the members of a profile.
URL
{WSUrl}/api/admin/profiles/<profile_id>/members[?[[&]$filter=<filter>][[&]page=<Page>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]
REQUEST METHOD
GET
URL PARAMETERS
page: Number of the page to be displayed. Valid values: from 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.
page_size: Number of items displayed per page. Valid values: from 1 to 1,000. If omitted, the default value of 10 items is used.
profile_id: This parameter is provided in the URL and does not need to be sent through GET.
filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.
orderby: Orders the members listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" for each field. The supported fields are listed below.
FIELDS SUPPORTED BY FILTER
Guid Id;
string Name;
string Type
For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.
REQUEST EXAMPLES
The first ten members of a profile (by default, 10 members are listed at a time):
{RMUrl}/api/admin/profiles/1/members
Members of a profile from 11 through 20 (second page):
{RMUrl}/api/admin/profiles/1/members?page=2
Filter by the ID of the member of a profile:
{RMUrl}/api/admin/profiles/1/members?$filter=Id eq ‘ 4144d537-9c02-11e6-80ed-00155d000602’
Filter by "Manage" in the "Name" field:
{RMUrl}/api/admin/profiles/1/members?$filter=substringof('Manage',Name)
SUCCESS RESPONSE
List of privileges according to the filters and page size specified.
Member[].
The Member object is in the following format:
Member
{
Guid Id;
string Name;
string Type;
}
SUCCESS RESPONSE EXAMPLE
[
{
"Id" : "fe80e585-e1f1-4f01-8193-e5bfb87b53d5",
"Name": "Dispatch Group",
"Type" : "Group"
},
{
"Id" : "Id=7b06ee69-12d6-11e5-80d9-00155d00020d",
"Name": "Administrator",
"Type" : "Person"
},
....
]