User Management API

Use the User Management APIs to create, search, update, or delete roles and users in your Control Room. You need the following permissions to create and manage users and roles.

View users
You need an administrator permission to create and manage users and roles. It is recommended that non-administrator users be given limited permissions for creating and managing users. Learn how to create a role with limited permissions that can be assigned to users.
Create users
Create new users in the Control Room.
Edit users
Edit all users in the Control Room, including users created by other administrators.
Delete users
Delete any user in the Control Room.
View roles
Users with this permission can view roles to which they have access.
Manage roles
Users can create, edit and delete roles to which they have access.
View licenses
Users with these permissions are able to view and manage device licenses. Device licenses are required to enable users to perform specific tasks. For example, Bot Creators require a DEVELOPMENT device license in order to create bots.
Manage users device license
Users with this permission can assign device licenses to other users.

For more information about roles and permissions, see Roles and permissions.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

User

post /users/list
post /users
delete /users/{uid}
get /users/{uid}
put /users/{uid}

Role

Up

delete /roles/{id}

Delete role (rolesIdDelete)

Use the Delete role API to delete an existing role in the Control Room. You must specify the role ID.

Path parameters

id (required)

Path Parameter — Unique object id

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Succesfull delete.

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /roles/{id}

Retrieve role by ID (rolesIdGet)

Use the Get role by ID API to retrieve a specific role by specifying the role ID.

Path parameters

id (required)

Path Parameter — Unique object id

Return type

Role

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "updatedBy" : 10.0,
  "createdBy" : 10.0,
  "Version" : 0.0,
  "permissions" : [ {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  }, {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  } ],
  "name" : "Finance role",
  "tenantId" : "1",
  "description" : "Finance role to manage the org finances",
  "principals" : [ {
    "emailVerified" : true,
    "deleted" : true,
    "domain" : "domain",
    "id" : 3.0,
    "pwdExpired" : true,
    "subjectId" : "27",
    "autoLoginEnabled" : true,
    "username" : "Bot_manager"
  }, {
    "emailVerified" : true,
    "deleted" : true,
    "domain" : "domain",
    "id" : 3.0,
    "pwdExpired" : true,
    "subjectId" : "27",
    "autoLoginEnabled" : true,
    "username" : "Bot_manager"
  } ],
  "id" : 264.0,
  "updatedOn" : "2022-11-21T16:22:02.697Z",
  "createdOn" : "2022-11-21T16:22:02.697Z"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Role Role

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /roles/{id}

Update role (rolesIdPut)

Use the Update role API to update an existing role in the Control Room. You must specify the role ID.

Path parameters

id (required)

Path Parameter — Unique object id

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body RoleModificationRequest (required)

Body Parameter —

Return type

Role

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "updatedBy" : 10.0,
  "createdBy" : 10.0,
  "Version" : 0.0,
  "permissions" : [ {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  }, {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  } ],
  "name" : "Finance role",
  "tenantId" : "1",
  "description" : "Finance role to manage the org finances",
  "principals" : [ {
    "emailVerified" : true,
    "deleted" : true,
    "domain" : "domain",
    "id" : 3.0,
    "pwdExpired" : true,
    "subjectId" : "27",
    "autoLoginEnabled" : true,
    "username" : "Bot_manager"
  }, {
    "emailVerified" : true,
    "deleted" : true,
    "domain" : "domain",
    "id" : 3.0,
    "pwdExpired" : true,
    "subjectId" : "27",
    "autoLoginEnabled" : true,
    "username" : "Bot_manager"
  } ],
  "id" : 264.0,
  "updatedOn" : "2022-11-21T16:22:02.697Z",
  "createdOn" : "2022-11-21T16:22:02.697Z"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Return updated role Role

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

409

Conflict Error

500

Internal Server error Error

Up

post /roles/list

List roles (rolesListPost)

Use the List Roles API to retrieve a list of roles in the Control Room. This endpoint supports pagination, sorting, and filtering. For more information, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-api-filter-request.html">Filtering, pagination, and sorting</a>.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

RoleFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 100,
    "total" : 100,
    "offset" : 0
  },
  "list" : [ {
    "updatedBy" : 29.0,
    "createdBy" : 27.0,
    "systemRole" : false,
    "name" : "device_admin",
    "description" : "This is a device admin role",
    "countPrincipals" : 1.0,
    "id" : 27.0,
    "updatedOn" : "2022-11-21T16:22:02.697Z",
    "version" : 1.0,
    "createdOn" : "2022-11-21T16:22:02.697Z"
  }, {
    "updatedBy" : 29.0,
    "createdBy" : 27.0,
    "systemRole" : false,
    "name" : "device_admin",
    "description" : "This is a device admin role",
    "countPrincipals" : 1.0,
    "id" : 27.0,
    "updatedOn" : "2022-11-21T16:22:02.697Z",
    "version" : 1.0,
    "createdOn" : "2022-11-21T16:22:02.697Z"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Found roles RoleFilterResponse

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /roles

Create role (rolesPost)

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

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body RoleModificationRequest (required)

Body Parameter —

Return type

Role

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "updatedBy" : 10.0,
  "createdBy" : 10.0,
  "Version" : 0.0,
  "permissions" : [ {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  }, {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  } ],
  "name" : "Finance role",
  "tenantId" : "1",
  "description" : "Finance role to manage the org finances",
  "principals" : [ {
    "emailVerified" : true,
    "deleted" : true,
    "domain" : "domain",
    "id" : 3.0,
    "pwdExpired" : true,
    "subjectId" : "27",
    "autoLoginEnabled" : true,
    "username" : "Bot_manager"
  }, {
    "emailVerified" : true,
    "deleted" : true,
    "domain" : "domain",
    "id" : 3.0,
    "pwdExpired" : true,
    "subjectId" : "27",
    "autoLoginEnabled" : true,
    "username" : "Bot_manager"
  } ],
  "id" : 264.0,
  "updatedOn" : "2022-11-21T16:22:02.697Z",
  "createdOn" : "2022-11-21T16:22:02.697Z"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Return created role Role

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

User

Up

post /users/list

List users (usersListPost)

Use the List users API to search and list users in the Control Room.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

UserFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 100,
    "total" : 100,
    "offset" : 0
  },
  "list" : [ {
    "lastName" : "Bots",
    "updatedBy" : 29.0,
    "roles" : [ {
      "name" : "name",
      "id" : 0.8008281904610115
    }, {
      "name" : "name",
      "id" : 0.8008281904610115
    } ],
    "description" : "User to manage bots",
    "principalId" : 110.0,
    "updatedOn" : "2022-11-21T16:22:02.697Z",
    "passwordSet" : true,
    "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
    "createdOn" : "2022-11-21T16:22:02.697Z",
    "emailVerified" : true,
    "firstName" : "Mike",
    "enableAutoLogin" : true,
    "createdBy" : 27.0,
    "permissions" : [ {
      "resourceId" : "resourceId",
      "action" : "managecredentials",
      "id" : 59.0,
      "resourceType" : "credentials"
    }, {
      "resourceId" : "resourceId",
      "action" : "managecredentials",
      "id" : 59.0,
      "resourceType" : "credentials"
    } ],
    "domain" : "domain",
    "clientRegistered" : true,
    "disabled" : true,
    "id" : 110.0,
    "email" : "xyz@automationanywhere.com",
    "questionsSet" : true,
    "username" : "bot_creator"
  }, {
    "lastName" : "Bots",
    "updatedBy" : 29.0,
    "roles" : [ {
      "name" : "name",
      "id" : 0.8008281904610115
    }, {
      "name" : "name",
      "id" : 0.8008281904610115
    } ],
    "description" : "User to manage bots",
    "principalId" : 110.0,
    "updatedOn" : "2022-11-21T16:22:02.697Z",
    "passwordSet" : true,
    "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
    "createdOn" : "2022-11-21T16:22:02.697Z",
    "emailVerified" : true,
    "firstName" : "Mike",
    "enableAutoLogin" : true,
    "createdBy" : 27.0,
    "permissions" : [ {
      "resourceId" : "resourceId",
      "action" : "managecredentials",
      "id" : 59.0,
      "resourceType" : "credentials"
    }, {
      "resourceId" : "resourceId",
      "action" : "managecredentials",
      "id" : 59.0,
      "resourceType" : "credentials"
    } ],
    "domain" : "domain",
    "clientRegistered" : true,
    "disabled" : true,
    "id" : 110.0,
    "email" : "xyz@automationanywhere.com",
    "questionsSet" : true,
    "username" : "bot_creator"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Found users UserFilterResponse

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /users

Create user (usersPost)

Use the Create user API to create a new user in the Control Room.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body UserDetailsModify (required)

Body Parameter —

Return type

UserDetails

Example data

Content-Type: application/json

{
  "lastName" : "Bots",
  "updatedBy" : 29.0,
  "roles" : [ {
    "name" : "name",
    "id" : 0.8008281904610115
  }, {
    "name" : "name",
    "id" : 0.8008281904610115
  } ],
  "description" : "User to manage bots",
  "principalId" : 110.0,
  "updatedOn" : "2022-11-21T16:22:02.697Z",
  "passwordSet" : true,
  "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
  "createdOn" : "2022-11-21T16:22:02.697Z",
  "emailVerified" : true,
  "firstName" : "Mike",
  "enableAutoLogin" : true,
  "createdBy" : 27.0,
  "permissions" : [ {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  }, {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  } ],
  "domain" : "domain",
  "clientRegistered" : true,
  "disabled" : true,
  "id" : 110.0,
  "email" : "xyz@automationanywhere.com",
  "questionsSet" : true,
  "username" : "bot_creator"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

OK UserDetails

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Up

delete /users/{uid}

Delete user (usersUidDelete)

Use the Delete user API to delete an existing user in the Control Room. You must specify the user ID.

Path parameters

uid (required)

Path Parameter — Unique object id

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Succesfull delete.

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /users/{uid}

Get user details (usersUidGet)

Use the Get user details API to retrieve a specific user details by specifying the user ID.

Path parameters

uid (required)

Path Parameter — Unique object id

Return type

UserDetails

Example data

Content-Type: application/json

{
  "lastName" : "Bots",
  "updatedBy" : 29.0,
  "roles" : [ {
    "name" : "name",
    "id" : 0.8008281904610115
  }, {
    "name" : "name",
    "id" : 0.8008281904610115
  } ],
  "description" : "User to manage bots",
  "principalId" : 110.0,
  "updatedOn" : "2022-11-21T16:22:02.697Z",
  "passwordSet" : true,
  "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
  "createdOn" : "2022-11-21T16:22:02.697Z",
  "emailVerified" : true,
  "firstName" : "Mike",
  "enableAutoLogin" : true,
  "createdBy" : 27.0,
  "permissions" : [ {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  }, {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  } ],
  "domain" : "domain",
  "clientRegistered" : true,
  "disabled" : true,
  "id" : 110.0,
  "email" : "xyz@automationanywhere.com",
  "questionsSet" : true,
  "username" : "bot_creator"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

user drauils UserDetails

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /users/{uid}

Update user details (usersUidPut)

Use the Update user details API to update an existing user information in the Control Room. You must specify the user ID.

Path parameters

uid (required)

Path Parameter — Unique object id

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body UserDetailsModify (required)

Body Parameter —

Return type

UserDetails

Example data

Content-Type: application/json

{
  "lastName" : "Bots",
  "updatedBy" : 29.0,
  "roles" : [ {
    "name" : "name",
    "id" : 0.8008281904610115
  }, {
    "name" : "name",
    "id" : 0.8008281904610115
  } ],
  "description" : "User to manage bots",
  "principalId" : 110.0,
  "updatedOn" : "2022-11-21T16:22:02.697Z",
  "passwordSet" : true,
  "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
  "createdOn" : "2022-11-21T16:22:02.697Z",
  "emailVerified" : true,
  "firstName" : "Mike",
  "enableAutoLogin" : true,
  "createdBy" : 27.0,
  "permissions" : [ {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  }, {
    "resourceId" : "resourceId",
    "action" : "managecredentials",
    "id" : 59.0,
    "resourceType" : "credentials"
  } ],
  "domain" : "domain",
  "clientRegistered" : true,
  "disabled" : true,
  "id" : 110.0,
  "email" : "xyz@automationanywhere.com",
  "questionsSet" : true,
  "username" : "bot_creator"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

updated user details UserDetails

400

Bad Rquest Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Models

Methods

Table of Contents

Error
Filter
FilterRequest
IdsList
LicenseFeature
PageRequest
PageResponse
Permission
Principal
Role
RoleBasic
RoleFilterResponse
RoleModificationRequest
Sort
UserDetails
UserDetailsModify
UserFilterResponse

`Error` Up

code (optional)

String Error code

message (optional)

String Message describing error

details (optional)

String More details of the error message

`Filter` Up

Filters the result based on operator, field, or value.

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

example: and

operands (optional)

array[Filter]

field (optional)

String Filtering field can be either username, first name, last name, description, user status, or email.

example: username

value (optional)

String Filter value

example: botcreator

`FilterRequest` Up

Filter request, which includes filtering, sorting, and pagination rules.

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`IdsList` Up

`LicenseFeature` Up

License feature

`PageRequest` Up

Pagingation rules, allows you to filter based on desired page

offset (optional)

Integer Page starting index

total (optional)

Integer Total number of items to display

example: 100

totalFilter (optional)

Integer Total number of items matching filter

example: 100

`PageResponse` Up

Pagingation response

offset (optional)

Integer Page starting index

total (optional)

Integer Total number of items

totalFilter (optional)

Integer Total number of items matching filter

`Permission` Up

id (optional)

BigDecimal The numeric value that uniquely identifies the permission.

example: 59.0

action (optional)

String The action the permission enables.

example: managecredentials

resourceId (optional)

String The resource id to which the action belongs.

resourceType (optional)

String The resource group to which the action belongs. Typically a user is given the role permission in conjunction with user management permission.

example: credentials

`Principal` Up

id (optional)

BigDecimal Unique identifier representing a principal

example: 3.0

username (optional)

String user login

example: Bot_manager

subjectId (optional)

String user id

example: 27

domain (optional)

String active directory domain, if Principal represents AD User

autoLoginEnabled (optional)

Boolean

deleted (optional)

Boolean

emailVerified (optional)

Boolean

pwdExpired (optional)

Boolean

`Role` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 264.0

name

String Name of the role

example: Finance role

description (optional)

String Description of the role

example: Finance role to manage the org finances

createdBy (optional)

BigDecimal Id of the user who created the role.

example: 10.0

createdOn (optional)

String The creation timestamp of the role.

example: 2022-11-21T16:22:02.697Z

updatedBy (optional)

BigDecimal Id of the user who last updated the role.

example: 10.0

updatedOn (optional)

String Timestamp when the role was last updated.

example: 2022-11-21T16:22:02.697Z

tenantId (optional)

String The unique identifier for the tenant and is based on the tenant name. The tenant ID is assigned to the tenant's resources.

example: 1

tenantUuid (optional)

String The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.

example: 4090a32b-79c1-4fd8-b88a-b1ea8c994cb0

Version (optional)

BigDecimal Latest version of the bot(applicale only with VCS ON)

example: 0.0

permissions (optional)

array[Permission] Collection of unique permissions that have been assigned to the role.

principals (optional)

array[Principal] An array of unique users that have been assigned to the role.

`RoleBasic` Up

id (optional)

BigDecimal Unique identifier representing a specific role

name

String Name of role

`RoleFilterResponse` Up

Filtered role list

page (optional)

PageRequest

list (optional)

array[Object]

`RoleModificationRequest` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 27.0

name

String Name of the role

example: Trigger Manager

description (optional)

String Description of the role

example: View and Manage the triggers

permissions (optional)

array[Permission] An array of permissions that will be granted for the role. Each permission requires the mandatory parameters.

principals (optional)

array[Principal] An array/collection of principals (users) who will be granted access with the role.

`Sort` Up

By default, search results are sorted in descending order with respect to their IDs. An alternative sorting is specified by using the sort query parameter.