Returns a paginated list of the privileges available in the system.
URL
{RMUrl}/api/admin/privileges[?[[&]$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.
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 privileges 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
string Code;
int Id;
string Name;
object Module;
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 privileges (by default, 10 privileges are listed at a time):
{RMUrl}/api/admin/privileges
Privileges 11 through 20 (second page):
{RMUrl}/api/admin/privileges?page=2
Filter by the ID of the privilege:
{RMUrl}/api/admin/privileges?$filter=Id eq 1
Filter by "Manage" in the "Name" field:
{RMUrl}/api/admin/privileges?$filter=substringof('Manage',Name)
SUCCESS RESPONSE
List of privileges according to the filters and page size specified.
Privilege[].
The Privilege object is in the following format:
Privilege
{
string Code;
int Id;
string Name;
object Module;
}
SUCCESS RESPONSE EXAMPLE
[
{
"Code" : "/General/Search_Content",
"Id" : 2,
"Name": "Search Content",
"Module" : { "Id": 0, "Name" : "General" }
},
{
"Code" : "Administration/OrganizationMessages_Manage",
"Id" : 5,
"Name": "Manage Corporate Messages",
"Module" : { "Id": 1, "Name" : "Administration" }
},
....
]