Create a new role using the API

Use Create role API to create a new role with permissions in the Enterprise Control Room.

Prerequisites

Each permission requires the following parameters:

id: The numeric value that uniquely identifies the permission.
action: The action the permission enables.
resourceType: The resource group to which the action belongs.

All 3 parameters are required to create the permission.

You need limited administrative permission to create roles.

View roles

View user roles.

Manage roles: Create and manage user roles

Typically a user is given the role permission in conjunction with user management permission. Permissions to roles mapping

URL: http://<your_control_room_url>/v1/usermanagement/roles
Replace the content in the angle brackets with your Enterprise Control Room URL.
Method: POST
Use the Swagger definition files installed with your Enterprise Control Room to test the APIs. View the available Swagger APIs at: http://<your_control_room_url>/swagger/
You can also use a REST client to complete this task.

Procedure

Add an authentication token to the request header.
Use the Authentication API to generate a JSON Web Token. See Authentication API overview.
Select POST as the method.
POST http://<your_control_room_url>/v1/usermanagement/roles
In the request body, enter a new name for the role.

Send the request.

The following request creates a new role that allows a user to create and manage roles and user in her Enterprise Control Room.

Request body:

{
  "name": "Role to manage users and roles",
  "description": "These are limited administrator permission.",
  "permissions": [
    {
      "id": 1,
      "action": "usermanagement",
      "resourceType": "usermanagement"
    },
    {
      "id": 3,
      "action": "createuser",
      "resourceType": "usermanagement"
    },
    {
      "id": 4,
      "action": "updateuser",
      "resourceType": "usermanagement"
    },
    {
      "id": 2,
      "action": "deleteuser",
      "resourceType": "usermanagement"
    },
    {
      "id": 62,
      "action": "rolesview",
      "resourceType": "rolesmanagement"
    },
    {
      "id": 12,
      "action": "rolesmanagement",
      "resourceType": "rolesmanagement"
    }
  ]
}

Send the request.

In Swagger, click Execute.
In a REST client, click SEND.

Response body:

{
  "id": 767,
  "createdBy": 3215,
  "createdOn": "2020-03-19T22:44:21Z",
  "updatedBy": 3215,
  "updatedOn": "2020-03-19T22:44:21Z",
  "tenantId": 1,
  "version": 0,
  "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
  "description": "These are limited administrator permission.",
  "name": "Role to manage users and roles",
  "accessRestriction": null,
  "permissions": [
    {
      "id": 1,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "usermanagement",
      "resourceId": null,
      "resourceType": "usermanagement"
    },
    {
      "id": 2,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "deleteuser",
      "resourceId": null,
      "resourceType": "usermanagement"
    },
    {
      "id": 4,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "updateuser",
      "resourceId": null,
      "resourceType": "usermanagement"
    },
    {
      "id": 12,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "rolesmanagement",
      "resourceId": null,
      "resourceType": "rolesmanagement"
    },
    {
      "id": 62,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "rolesview",
      "resourceId": null,
      "resourceType": "rolesmanagement"
    },
    {
      "id": 3,
      "createdBy": 0,
      "createdOn": "2019-05-21T03:09:31Z",
      "updatedBy": 0,
      "updatedOn": "2019-05-21T03:09:31Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "action": "createuser",
      "resourceId": null,
      "resourceType": "usermanagement"
    }
  ],
  "countPrincipals": 0,
  "principals": []
}

Note: You can also run REST requests from a command terminal. The following is a curl request example. This example is formatted for readability. Replace the text inside the angle brackets, <authentication_token>, with your authentication token. This example has been formatted for readability.

curl -X POST "https://<your_control_room_url>/v1/usermanagement/roles" 
-H "accept: application/json" 
-H "X-Authorization: <token>" 
-H "Content-Type: application/json" -d "{ "name": "Role to manage user and roles", 
"description": "These are limited administrator permission.", 
"permissions": [ {
  "name": "Role to manage users and roles",
  "description": "These are limited administrator permission.",
  "permissions": [
    {
      "id": 1,
      "action": "usermanagement",
      "resourceType": "usermanagement"
    },
    {
      "id": 3,
      "action": "createuser",
      "resourceType": "usermanagement"
    },
    {
      "id": 4,
      "action": "updateuser",
      "resourceType": "usermanagement"
    },
    {
      "id": 2,
      "action": "deleteuser",
      "resourceType": "usermanagement"
    },
    {
      "id": 62,
      "action": "rolesview",
      "resourceType": "rolesmanagement"
    },
    {
      "id": 12,
      "action": "rolesmanagement",
      "resourceType": "rolesmanagement"
    }
  ]
} 
]
}"

Product

Version

Task

Information Type

Create a new role using the API

Prerequisites

Procedure

Documentation

Contents

Child Topics

Product

Version

Task

Information Type

Create a new role using the API

Prerequisites

Procedure

Documentation

Contents

Child Topics

Related Content

Add to My Topics

Choose collection

Create a Collection

Rate this topic

Error