Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Retrieve role

  • Updated: 2022/04/13
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Retrieve role

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

Request

GET https://{{ControlRoomURL}}/v1/usermanagement/roles/<role ID>
Header: X-Authorization <<authentication token>>
All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON Web Token. See Authentication API.

Request Parameters

Parameter Type Required Description
role ID Integer Yes Enter the Id of the role.

Response

200 OK
{
    "id": 264,
    "createdBy": 10,
    "createdOn": "2022-04-12T12:12:39Z",
    "updatedBy": 10,
    "updatedOn": "2022-04-12T12:12:39Z",
    "tenantId": 1,
    "version": 0,
    "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
    "description": "",
    "name": "Device admin",
    "permissions": [
        {
            "id": 1345,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "managecredentials",
            "resourceId": null,
            "resourceType": "credentials"
        },
        {
            "id": 1424,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "delete",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1425,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "edit",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1344,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "myschedule",
            "resourceId": null,
            "resourceType": "taskscheduling"
        },
        {
            "id": 1426,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "view",
            "resourceId": null,
            "resourceType": "dashboard"
        },
        {
            "id": 1414,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "attestcredentials",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1381,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "register",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1321,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "view",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1423,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "all",
            "resourceId": null,
            "resourceType": "devices"
        }
    ],
    "countPrincipals": 0,
    "systemRole": false,
    "principals": [
        {
            "id": 21,
            "createdBy": 10,
            "createdOn": "2022-04-12T12:12:19Z",
            "updatedBy": 21,
            "updatedOn": "2022-04-13T03:37:08Z",
            "tenantId": 1,
            "version": 19,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "username": "john_user",
            "description": "User",
            "deleted": false,
            "disabled": false,
            "email": "john.doe@aa.com",
            "firstName": "John",
            "lastName": "Doe",
            "autoLoginEnabled": true,
            "emailVerified": true,
            "clientRegistered": false,
            "passwordSet": true,
            "questionsSet": true,
            "activeDirectory": false,
            "passwordChangedOn": "2022-04-12T12:13:35Z",
            "deviceCredentialAttested": false,
            "multipleLoginAllowed": true
        }
    ]
}

Response Parameters

Parameter Type Description
id Integer Unique identifier representing the new role created.
name String Name of the role created.
description String Description of the role created.
version Integer Version of the role instance.
createdBy Integer Id of the user who created the role.
createdOn String The creation timestamp of the role.
updatedBy Integer Id of the user who made a latest update to the role.
updatedOn String The latest update timestamp of the role.
permissions Array An array of unique permissions that have been assigned to the role.
principals Array An array of unique users that have been assigned to the role.
Note: View the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.
The REST API responds to each request with an HTTP response code. For response codes, see API response codes.
Send Feedback