View Role Properties (Deprecated)
Select
SaaS
Customer Managed
deprecated
This endpoint has been deprecated and may be removed in future versions of the API.
This operation returns the properties associated with a role.
Path Parameters
- roleId string required
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
roleProperties object[]
visibility integerdescription stringrole object
roleId integerroleName stringflags object
disabled booleancategoryPermission object
categoriesPermissionList object[]
srmReportSet integertype integersrmReportType integerclientSidePackage booleancategoryName string_type_ integerconsumeLicense booleancategoryId integerpermissionId integerpermissionName stringsecurityAssociations object
associations object[]
userOrGroup object[]
srmReportSet integertype integersrmReportType integerclientSidePackage booleanuserId integer_type_ integeruserName stringconsumeLicense booleanproperties object
isCreatorAssociation booleanrole object
_type_ integerroleId integerroleName stringownerAssociations object
{
"roleProperties": [
{
"visibility": 0,
"description": "string",
"role": {
"roleId": 0,
"roleName": "string",
"flags": {
"disabled": true
}
},
"categoryPermission": {
"categoriesPermissionList": [
{
"srmReportSet": 0,
"type": 0,
"srmReportType": 0,
"clientSidePackage": true,
"categoryName": "string",
"_type_": 0,
"consumeLicense": true,
"categoryId": 0,
"permissionId": 0,
"permissionName": "string"
}
]
},
"securityAssociations": {
"associations": [
{
"userOrGroup": [
{
"srmReportSet": 0,
"type": 0,
"srmReportType": 0,
"clientSidePackage": true,
"userId": 0,
"_type_": 0,
"userName": "string",
"consumeLicense": true
}
],
"properties": {
"isCreatorAssociation": true,
"role": {
"_type_": 0,
"roleId": 0,
"roleName": "string"
}
}
}
],
"ownerAssociations": {}
}
}
]
}
{
"roleProperties": [
{
"visibility": 0,
"description": "testing role modification.",
"role": {
"roleId": 34,
"roleName": "TestRole",
"flags": {
"disabled": false
}
},
"categoryPermission": {
"categoriesPermissionList": [
{
"srmReportSet": 0,
"type": 0,
"srmReportType": 0,
"clientSidePackage": true,
"categoryName": "Alert",
"_type_": 121,
"consumeLicense": true,
"categoryId": 117
},
{
"srmReportSet": 0,
"type": 0,
"srmReportType": 0,
"clientSidePackage": true,
"permissionId": 2,
"permissionName": "Agent Management",
"categoryName": "Client",
"_type_": 122,
"consumeLicense": true,
"categoryId": 102
},
{
"srmReportSet": 0,
"type": 0,
"srmReportType": 0,
"clientSidePackage": true,
"permissionId": 3,
"permissionName": "Agent Scheduling",
"categoryName": "Client",
"_type_": 122,
"consumeLicense": true,
"categoryId": 102
}
]
},
"securityAssociations": {
"associations": [
{
"userOrGroup": [
{
"srmReportSet": 0,
"type": 0,
"srmReportType": 0,
"clientSidePackage": true,
"userId": 1,
"_type_": 13,
"userName": "testadmin",
"consumeLicense": true
}
],
"properties": {
"isCreatorAssociation": true,
"role": {
"_type_": 120,
"roleId": 3,
"roleName": "View"
}
}
}
],
"ownerAssociations": {}
}
}
]
}
Loading...