Update a role

Contents

Use this API to update a role and its privileges.

Method	URL	Required authentication
PUT	/V1/CMDB/Roles	Yes

Name	Description
Token*required (header)	Place the token received from the API Log in to get an authentication token.
Request*required (body)	The body contains the following parameters: ▪newRoleName (string): a new name of the role. No change will be made if newRoleName, description, and privileges fields are all null. ▪roleName*(string): the name of the role that you want to update. ▪description (string): the description of the role. ▪privileges (string): the privileges that the role owns. Example: { "newRoleName": "Role Name", "roleName": "Role Name", "description": "string", "privileges": "string" }

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

Request*required
(body)

The body contains the following parameters:

▪newRoleName (string): a new name of the role. No change will be made if newRoleName, description, and privileges fields are all null.

▪roleName*(string): the name of the role that you want to update.

▪description (string): the description of the role.

▪privileges (string): the privileges that the role owns.

Example:

{
  "newRoleName": "Role Name",
  "roleName": "Role Name",
  "description": "string",
  "privileges": "string"
}

Parameter	Type	Description	Example
statusCode	integer	The returned status code of executing the API.	{ "statusCode": 790200, "statusDescription": "success" }
statusDescription	string	The explanation of the status code.	{ "statusCode": 790200, "statusDescription": "success" }