Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Retrieve a specific role API

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

Retrieve a specific role API

Use the Get role by ID API to retrieve a specific role in the Control Room.

Prerequisites

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

  • URL: http://<your_control_room_url>/v1/usermanagement/roles/2 <role ID>
  • Method: GET
  • Use the Swagger definition files installed with your 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

  1. Add the authentication token to the request header.
  2. Add a role ID that you want to retrieve, for example, customRole.
  3. Use the GET method and endpoint URL: <your_control_room_url>/v1/usermanagement/roles/2 <role ID>
  4. Send the request.

    Response body:

    {
      "id": 740,
      "createdBy": 2623,
      "createdOn": "2020-02-24T19:08:09Z",
      "updatedBy": 2623,
      "updatedOn": "2020-02-24T19:08:09Z",
      "tenantId": 1,
      "version": 0,
      "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
      "description": "",
      "name": "customRole",
      "accessRestriction": null,
      "permissions": [
        {
          "id": 59,
          "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": "managecredentials",
          "resourceId": null,
          "resourceType": "credentials"
        },
        {
          "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": 58,
          "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": "myschedule",
          "resourceId": null,
          "resourceType": "taskscheduling"
        },
        {
          "id": 97,
          "createdBy": 0,
          "createdOn": "2019-05-21T03:09:39Z",
          "updatedBy": 0,
          "updatedOn": "2019-05-21T03:09:39Z",
          "tenantId": 1,
          "version": 0,
          "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
          "action": "view",
          "resourceId": null,
          "resourceType": "dashboard"
        },
        {
          "id": 30,
          "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": "view",
          "resourceId": null,
          "resourceType": "devices"
        }
      ],
      "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