Update a Role (Deprecated)

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

This operation creates a role.

More Details

Path Parameters

roleId string required

application/json

Request Body

roles object[]
description string
role object
roleName string
flags object
disabled boolean
categoryPermission object
categoriesPermissionOperationType integer
categoriesPermissionList object[]
categoryName string
permissionName string

Responses

application/json

Schema
Example (from schema)
Update a Role

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

{
  "response": [
    {
      "errorString": "Successful",
      "errorCode": 0,
      "entity": {
        "roleName": "TestRole",
        "roleId": 34
      }
    }
  ]
}

POST /role/:roleid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

roleId — path required

Content-Type

Body

Default
Update a Role
Example 1

{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Role/:roleId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "roles": [
    {
      "description": "string",
      "role": {
        "roleName": "string",
        "flags": {
          "disabled": true
        }
      },
      "categoryPermission": {
        "categoriesPermissionOperationType": 0,
        "categoriesPermissionList": [
          {
            "categoryName": "string",
            "permissionName": "string"
          }
        ]
      }
    }
  ]
}'

Update a Role (Deprecated)​

Authorization

Request

Update a Role (Deprecated)