Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Update a role API

  • Updated: 4/07/2021
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Update a role API

Use the Update role API to update an existing role in the Control Room.

Prerequisites

Ensure you have an admin role or a custom role with Edit Roles permission.

Procedure

  1. Add the authentication token to the request header.
  2. Use the PUT method and endpoint URL:<your_control_room_url>/v1/usermanagement/roles/2 <role ID>
  3. In the request URL, add a role ID you want to update. This example shows how to add a single permission, View users to the custom role with the ID of 740.

    Request body:

    {
      "id": null,
      "name": "Add_one_permission",
      "accessRestriction": null,
      "permissions": [
        {
          "id": 1,
          "action": "usermanagement",
          "resourceType": "usermanagement"
        }
      ]
    }
  4. Send the request.

    Response body:

    {
      "id": 740,
      "createdBy": 2623,
      "createdOn": "2020-02-24T19:08:09Z",
      "updatedBy": 3215,
      "updatedOn": "2020-03-20T21:40:34Z",
      "tenantId": 1,
      "version": 4,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "description": null,
      "name": "Add_one_permission",
      "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"
        }
      ],
      "countPrincipals": 0,
      "principals": []
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback