Skip to main content

Create a Role​

Select

SaaS
Customer Managed

Create a new role

Request Body
  • name string required

    Name of the new role

  • permissionList object[] required

    Used to provide the list of permissions associated with the role.

  • permission object
  • id int32
  • name string
  • category object
  • id int32
  • name string
  • enabled boolean

    Used to determine if the role is enabled or disabled. If not provided, role will be enabled by default.

  • visibleToAll boolean

    Determines if the role is visible to everyone. if not provided, it will be set to false by default.

  • globalConfigInfo object

    Only applicable to Global CommCells. Not applicable for SaaS.

  • name string
  • commcells object[]

    List of Service CommCells where the global configuration should be applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config has to be applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string using for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • actionOnLocalEntity string

    Possible values: [CREATE_NEW, TAKE_OVER, FAIL_IF_EXIST]

    Action that will be taken on the local entity that has the same name as the global entity that needs to be created

Responses

Success

Schema
  • id int32
  • GUID string
  • name string
POST /v4/role

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "name": "string",

  "permissionList": [

    {

      "permission": {

        "id": 0,

        "name": "string"

      },

      "category": {

        "id": 0,

        "name": "string"

      }

    }

  ],

  "enabled": true,

  "visibleToAll": true,

  "globalConfigInfo": {

    "name": "string",

    "commcells": [

      {

        "id": 0,

        "name": "string",

        "guid": "string"

      }

    ],

    "scope": "string",

    "scopeFilterQuery": "string",

    "applyOnAllCommCells": true,

    "actionOnLocalEntity": "CREATE_NEW"

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Role' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "permissionList": [
    {
      "permission": {
        "id": 0,
        "name": "string"
      },
      "category": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "enabled": true,
  "visibleToAll": true,
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  }
}'