Get Roles

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

Description

The getRoles operation returns 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

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 Use dark colors for code blocksCopy `1 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 Use dark colors for code blocksCopy `1 pageSize=20`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

startIndex

The starting index (zero-based) from the roles list that must be returned in the result page. The default is 0.

Example
Use dark colors for code blocksCopy
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
Use dark colors for code blocksCopy
pageSize=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 getRoles operation that seeks to return 20 roles starting from the 10th position:

Use dark colors for code blocksCopy
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

Use dark colors for code blocksCopy
{
  "roles": [<role1>, <role2>],
  "hasMore": <true|false>
}