Get Roles

• URL:https://<roles-url>/getRoles (POST only)
  
• Required Capability:Default administrator role | All authorized privileges
• Version Introduced:10.1

Description

This operation gives you a pageable view of roles in the role store. It is intended for iterating through all available role accounts. To search for specific role accounts instead, use the Search Roles operation.

Request parameters

Parameter	Details
startIndex	The starting index (zero-based) from the roles list that must be returned in the result page. The default is 0. Example startIndex=9
pageSize	The maximum number of roles to return in the result page. The default size is 10. The pageSize is also governed by the underlying implementation of the role store. Example pageSize=20
f	The response format. The default response format is html. Values: html | json | pjson

Example usage

Below is a sample POST request to get 20 roles starting from the 10th position:

POST /webadaptor/admin/security/roles/getRoles HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

startIndex=9&pageSize=20&f=json

JSON Response syntax

{
  "roles": [<role1>, <role2>],
  "hasMore": <true|false>
}