Update a Role - PUT /Roles/{id}



Update role details according to Role Id.

The ‘Manage Roles’ permission is required to execute this API.

Usage:

  1. GET /Roles/{id} and get details of a role
  2. PUT /Roles/{id} and update role details

URL

/cxrestapi/auth/Roles/{id}

Method:

PUT

Media Type (header):

Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0

Parameters

Required:

id=[integer] - Unique Id of the role

updateRoleModel=[body]: Specifies the role’s details
name=[string] - Role name
description=[string] - Role description
permissionIds=[integer] - Role related permission Ids

Success Response:

Code: 204 Success

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not found

Sample Response:

no content

Notes:

Updates the role details according to role Id. Once the request is successful, it does not return any content. If the request fails, it returns an error response.




Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to usWe appreciate your feedback!