Create New Role - POST /Roles

Create a new role.

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

Usage:

POST /Roles and create a new role
GET /Users and get details of all roles

URL

/cxrestapi/auth/Roles

Method:

POST

Media Type (header):

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

Parameters

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

Success Response:

Code: 201 Success (returns location of the created role in the response header)

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

no content

Notes:

Returns the location of the created role in the response header. If the request fails, it returns an error response.

In this section