View Roles (REST API: GET)

This operation returns a list of roles.

Request

Syntax

GET <webservice>/Role?propertyLevel={1|10|30} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
propertyLevel	The level of detail to return in the response. If the propertyLevel parameter is not defined, the role names and the descriptions are returned. Valid values: 1, lists the role names 10, lists the role names and the descriptions 30, lists the role names and the descriptions and displays the permissions that are in the role	No

Name

Description

Required

propertyLevel

The level of detail to return in the response. If the propertyLevel parameter is not defined, the role names and the descriptions are returned.

Valid values:

1, lists the role names
10, lists the role names and the descriptions
30, lists the role names and the descriptions and displays the permissions that are in the role

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
description	The description of the role.	RoleProperties
visibility		RoleProperties
roleId	The system-generated ID assigned to the role.	role
roleName	The name of the role.	role
disabled	Indicates whether the role is enabled or disabled. Valid values are true/false.	flags
_type_	The type of permissions that are included in the role. Valid values: ALL_CATEGORIES, the role includes all of the permissions CATEGORY_ENTITY, the role includes all of the permissions in a specific category PERMISSION_ENTITY, the role includes individual permissions	categoriesPermissionList
categoryId	The system-generated ID assigned to the permission category.	categoriesPermissionList
categoryName	The name of the permission category, for example, Global.	categoriesPermissionList
permissionId	The ID of the security permission. For a list of valid values, see Security Permission IDs and Names.	categoriesPermissionList
permissionName	The name of the permission, for example, Create Alert.	categoriesPermissionList
exclude	Excludes an individual permission when the role includes a permission category. For example, a role includes the entire Alert permission category, but excludes the Create Alert permission. `<categoriesPermissionList _type_="CATEGORY_ENTITY" categoryId="117" categoryName="Alert"/> <categoriesPermissionList _type_="PERMISSION_ENTITY" categoryId="117" categoryName="Alert" permissionId="151" permissionName="Create Alert" type="GALAXY"> <flags exclude="true"/> </categoriesPermissionList>` Valid values are true/false.	flags
securityAssociations	If the role itself is the entity in a security association, the <securityAssociations> block is populated. For example, the Master role is view-only for the admin trainee user group: `<securityAssociations> <associations> <userOrGroup _type_="USERGROUP_ENTITY" userGroupId="4" userGroupName="admin trainee"/> <properties isCreatorAssociation="false"> <role _type_="ROLE_ENTITY" roleId="3" roleName="View"/> </properties> </associations> <ownerAssociations/> </securityAssociations>`	roleProperties

Examples

Sample Request

This request does not define the propertyLevel parameter, so the default propertyLevel of 10 is used in the request.

GET <webservice>/Role HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request uses 1 for the propertyLevel parameter.

GET <webservice>/Role?propertyLevel=1 HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request uses 30 for the propertyLevel parameter.

GET <webservice>/Role?propertyLevel=30 HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This is the response when the propertyLevel parameter is not defined.

{
   "roleProperties":[{
     "visibility":0,
     "description":"System Created Role with all permissions",
     "role":{
       "roleId":1,
       "roleName":"Master",
       "flags":{
         "disabled":false
       }
     }
   },{
     "visibility":0,
     "description":"System Created Role for View permission",
     "role":{
       "roleId":3,
       "roleName":"View",
       "flags":{
         "disabled":false
       }
     }
   },{
     "visibility":0,
     "description":"System created role for alert owners",
     "role":{
       "roleId":14,
       "roleName":"Alert Owner",
       "flags":{
         "disabled":false
       }
     }
   }
  ]
 }

This is the response when the propertyLevel parameter is 1.

{
   "roleProperties":[{
     "role":{
       "roleId":1,
       "roleName":"Master",
       "flags":{
         "disabled":false
       }
     }
   },{
     "role":{
       "roleId":3,
       "roleName":"View",
       "flags":{
         "disabled":false
       }
     }
   },{
     "role":{
       "roleId":14,
       "roleName":"Alert Owner",
       "flags":{
         "disabled":false
       }
     }
   }
  ]
 }

This is the response when the propertyLevel parameter is 30.

{ 
    "roleProperties":[ 
       { 
          "visibility":0,
          "description":"System Created Role with all permissions",
          "role":{ 
             "roleId":1,
             "roleName":"Master",
             "flags":{ 
                "disabled":false
             }
          },
          "categoryPermission":{ 
             "categoriesPermissionList":[ 
                { 
                   "srmReportSet":0,
                   "type":0,
                   "srmReportType":0,
                   "clientSidePackage":true,
                   "_type_":123,
                   "consumeLicense":true
                }
             ]
          },
          "securityAssociations":{ 
             "ownerAssociations":{ 
             }
          }
       },{ 
          "visibility":0,
          "description":"System Created Role for View permission",
          "role":{ 
             "roleId":3,
             "roleName":"View",
             "flags":{ 
                "disabled">:false
             }
          },
          "categoryPermission">:{ 
             "categoriesPermissionList">:[ 
                { 
                   "srmReportSet">:0,
                   "type">:0,
                   "srmReportType">:0,
                   "clientSidePackage">:true,
                   "permissionId">:31,
                   "permissionName">:"View",
                   "categoryName">:"Global",
                   "_type_">:122,
                   "consumeLicense">:true,
                   "categoryId">:107
                }
             ]
          },
          "securityAssociations">:{ 
             "ownerAssociations">:{ 
             }
          }
       },{ 
          "visibility":0,
          "description":"System created role for alert owners",
          "role":{ 
             "roleId":14,
             "roleName":"Alert Owner",
             "flags":{ 
                "disabled":false
             }
          },
          "categoryPermission":{ 
             "categoriesPermissionList":[ 
                { 
                   "srmReportSet":0,
                   "type":0,
                   "srmReportType":0,
                   "clientSidePackage":true,
                   "categoryName":"Alert",
                   "_type_":121,
                   "consumeLicense":true,
                   "categoryId":117
         sp;},
                { 
                   "srmReportSet":0,
                   "type":0,
                   "srmReportType":0,
                   "clientSidePackage":true,
                   "permissionId":31,
                   "permissionName":"View",
                   "categoryName":"Global",
                   "_type_":122,
                   "consumeLicense":true,
                   "categoryId":107
                },
                { 
                   "srmReportSet":0,
                   "type":0,
                   "srmReportType":0,
                   "clientSidePackage":true,
                   "permissionId":107,
                   "permissionName":"Change security settings",
                   "categoryName":"Global",
                   "_type_":122,
                   "consumeLicense":true,
                   "categoryId":107
                },
                { 
                   "srmReportSet":0,
                   "type":0,
                   "srmReportType":0,
                   "clientSidePackage":true,
                   "permissionId":151,
                   "permissionName":"Create Alert",
                   "categoryName":"Alert",
                   "_type_":122,
                   "consumeLicense":true,
                   "categoryId":117,
                   "flags":{ 
                      "exclude":true
                   }
                }
             ]
          },
          "securityAssociations":{ 
             "ownerAssociations":{ 
             }
          }
       }
    ]
 }