Create a Role (REST API: POST)

This operation creates a role.

Request

Syntax

Send the request using either XML or JSON:

XML

 
POST <webservice>/Role HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml
<create_role_template.xml>

JSON

 
POST <webservice>/Role HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>
Content-type: application/json
<create_role_template.json>

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 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.
Content-type	The media type contained in the request body.

Request Body

Download the XML or JSON file required for this request: create_role_template.xml or create_role_template.json. The following table displays the parameters for the request body.

Parameter	Description	Element
description	The description of the role.	roles
roleName	The name of the role.	role
disabled	Indicates whether the role is enabled or disabled. Valid values are True/False.	flags
categoriesPermissionOperationType	Adds permissions and permission categories to the role. Valid values is ADD.	categoriesPermission
permissionName	The permissions to add to the role. To add multiple permissions to the role, add the following block in the XML file for each permission: `<categoriesPermissionList> <permissionName>permission_name</permissionName> </categoriesPermissionList>` For a list of valid values, see Role Security Permissions and Permitted Actions.	categoriesPermissionList
categoryName	The name of the permission category to add to the role. To add multiple categories to the role, add the following block in the XML file for each category: `<categoriesPermissionList> <categoryName>category_name</categoryName> </categoriesPermissionList>` Valid values are: Access Policies Alert Analytics Billing Client Client Group CommCell Content Director Custom Property Developer Tools Features Global Monitoring Policy Plan Schedule Policy Storage Management Storage Provisioning Subclient Policy User Management VM Operations	categoriesPermissionList
exclude	Excludes an individual permission when the role includes a permission category. For example, a role includes the entire Client permission category, but excludes the Annotation Management permission: `<categoryPermission> <categoriesPermissionOperationType>ADD</categoriesPermissionOperationType> <categoriesPermissionList> <categoryName>Client</categoryName> </categoriesPermissionList> <categoriesPermissionList> <flags> <exclude>true</exclude> </flags> <categoryName>Client</categoryName> <permissionName>Annotation Management</permissionName> </categoriesPermissionList> </categoryPermission>`	flags

Response

Response Parameters

Parameter	Description	Element
errorCode	The possible error codes. Valid values are: 0, successful completion. 2, a failure. a specific error code.	response
errorString	The description of the error code. Not all error codes have an error string.	response
roleName	The name of the role.	entity
roleId	The system-generated ID assigned to the role.	entity
disabled	Indicates whether the role is enabled or disabled. Valid values are True/False.	flags

Examples

Sample Request

POST <webservice>/Role HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
 <?xml version="1.0" encoding="UTF-8"?>
 <Security_CreateRoleRequest>
    <roles>
       <role>
          <roleName>Trainer</roleName>
          <flags>
             <disabled>false</disabled>
          </flags>
       </role>
       <description></description>
       <categoryPermission>
          <categoriesPermissionList>
            <categoryName>Alert</categoryName>
          </categoriesPermissionList>
          <categoriesPermissionList>
             <permissionName>Agent Management</permissionName>
          </categoriesPermissionList>
          <categoriesPermissionList>
             <permissionName>Agent Scheduling</permissionName>
          </categoriesPermissionList>
          <categoriesPermissionOperationType>ADD</categoriesPermissionOperationType>
       </categoryPermission>
    </roles>
 </Security_CreateRoleRequest>

Sample Response

{ 
    "response":[ 
       { 
          "errorString":"Successful",
          "errorCode":0,
          "entity":{ 
             "roleName":"Trainer",
             "roleId":20,
             "flags":{ 
                "disabled":false
             }
          }
       }
    ]
}