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.

More Details

Path Parameters

• roleId string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• roleProperties object[]

  visibility integer

  description string

  role object

  roleId integer

  roleName string

  flags object

  disabled boolean

  categoryPermission object

  categoriesPermissionList object[]

  srmReportSet integer

  type integer

  srmReportType integer

  clientSidePackage boolean

  categoryName string

  _type_ integer

  consumeLicense boolean

  categoryId integer

  permissionId integer

  permissionName string

  securityAssociations object

  associations object[]

  userOrGroup object[]

  srmReportSet integer

  type integer

  srmReportType integer

  clientSidePackage boolean

  userId integer

  _type_ integer

  userName string

  consumeLicense boolean

  properties object

  isCreatorAssociation boolean

  role object

  _type_ integer

  roleId integer

  roleName string

  ownerAssociations 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": {}
      }
    }
  ]
}

GET /role/:roleid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

roleId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'