Roles

Owned by Nina Cardillo
29-Sept-2023
1 min read

URI Definition

Method

URI and Fields

GET

/iap/roles

Returns a collection of existing roles. When nothing is specified, returns all defined roles in the system.

Query Parameters

  • id – id of a permission
  • name – name of permission
  • pg – page number
  • sz – page size

Success Response

Collection of existing roles.

Example

https://localhost/iap/roles?pg=1&sz=50


Response

[
   {
       "id": 67,
       "name": "Scheduler",
       "inherited": false
   },
   {
       "id": 68,
       "name": "Configuration Manager",
       "inherited": false
   },
   {
       "id": 64,
       "name": "Tenant",
       "inherited": false
   },
   {
       "id": 65,
       "name": "Controller",
       "inherited": false
   },
   {
       "id": 66,
       "name": "Asset Manager",
     "inherited": false
   }
]                                                                                                                                                   

Query Parameters

Optional query parameters can be used with your REST request.  Specifying queries is described under Queries and Parameters, Path Parameters, and Query Parameters.