Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Update role

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

Update role

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

Request

PUT 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 body:
{
   "id":25,
   "name":"Trigger Manager",
   "principals":[
      {
         "id":3
      },
      {
         "id":4
      }
   ],
   "description":"View and Manage the triggers",
   "permissions":[
      {
         "id":148,
         "action":"view",
         "resourceType":"dashboard",
         "resourceId":null
      },
      {
         "id":58,
         "action":"myschedule",
         "resourceType":"taskscheduling",
         "resourceId":null
      },
      {
         "id":149,
         "action":"view",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":150,
         "action":"manage",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":131,
         "action":"managemytriggers",
         "resourceType":"eventtriggers",
         "resourceId":null
      },
      {
         "id":59,
         "action":"managecredentials",
         "resourceType":"credentials",
         "resourceId":null
      },
      {
         "id":30,
         "action":"view",
         "resourceType":"devices",
         "resourceId":null
      }
   ],
   "existingRepositoryPermissions":[
      
   ],
   "version":0
}

Request Parameters

Parameter Type Required Description
name String Yes Enter the name of the role.
description String No Description of the role.
permissions Array No An array of permissions that will be granted for the role. Each permission requires the mandatory parameters. For more details on the parameters, see below.
principals Array No An array/collection of principals (users) who will be granted access with the role. For more information on the parameters, see below.
permission array parameters
Parameter Type Required Description
id Integer No The numeric value that uniquely identifies the permission.
action String No The action the permission enables.
resourceId String No The resource id to which the action belongs.
resourceType Array No The resource group to which the action belongs.

Typically a user is given the role permission in conjunction with user management permission. Roles and permissions

prinicpals array parameters
Parameter Type Required Description
id Integer No Id of the user.
username String No User name of the user.
subjectId String No Subject Id of the user.
domain String No Active directory domain, if the user is an AD User.
autoLoginEnabled Boolean No Flag to indicate if auto login is enabled or not.
deleted Boolean No Flag to indicate if user is deleted or not.
emailVerified Boolean No Flag to indicate if email is verified or not.
pwdExpired Boolean No Flag to indicate if password is expired or not.

Response

200 OK
{
   "id":25,
   "createdBy":1,
   "createdOn":"2022-04-11T11:53:03Z",
   "updatedBy":1,
   "updatedOn":"2022-04-11T12:01:31Z",
   "tenantId":1,
   "version":1,
   "tenantUuid":"282978c4-6386-c13a-92ac-5009e3cfd6b3",
   "description":"View and Manage the triggers",
   "name":"Trigger Manager",
   "permissions":[
      {
         "id":59,
         "createdBy":0,
         "createdOn":"2022-02-2