How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

automation-anywhere Roles API

Create, list, retrieve, update, and delete user roles

automation-anywhere Roles API is one of 22 APIs that Automation Anywhere publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2019.

Requests are made against a single base URL, https://{controlRoomUrl}/orchestrator/v1/hotbot.

5 operations 3 paths 12 schemas 1 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2019
Base URL
https://automationanywhere-be-prod.automationanywhere.com
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

automation-anywhere Roles API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-Authorization (xAuthorization). By default, every request must be authenticated.

  • bearerAuth — JWT token obtained from the Authentication API
  • xAuthorization — JWT token obtained from the Authentication API

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Roles 5

Create, list, retrieve, update, and delete user roles

POST
/v2/usermanagement/roles
Create a role
createRole body → 201400401
POST
/v2/usermanagement/roles/list
List roles
listRoles body → 200400401
GET
/v2/usermanagement/roles/{id}
Get role by ID
getRole 1 param → 200401404
PUT
/v2/usermanagement/roles/{id}
Update a role
updateRole 1 param body → 201400401404
DELETE
/v2/usermanagement/roles/{id}
Delete a role
deleteRole 1 param → 204401404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are RoleResponse (8 properties), FilterRequest (4 properties), Permission (4 properties), PageInfo (3 properties). Each schema is shown below with its type and property counts.

Error
object
Standard error response returned when an API request fails
3 properties
RoleListResponse
object
Paginated list of role records
2 properties
FilterRequest
object
Generic filtering, pagination, and sorting request body used across list endpoints throughout the Control Room API.
4 properties
CreateRoleRequest
object
Payload to create a new Control Room role
3 properties 1 required
SortCriteria
object
Sorting direction and field for list results
2 properties
PageRequest
object
Pagination parameters for list requests
2 properties
FilterExpression
object
Logical filter expression for querying resources
2 properties
UpdateRoleRequest
object
Payload to update an existing Control Room role
3 properties
RoleResponse
object
Full role record returned from create, read, or update operations
8 properties
PageInfo
object
Pagination metadata returned with list responses
3 properties
FilterOperand
object
A single operand in a filter expression, either a field reference or a nested expression
2 properties
Permission
object
A single permission entry granting access to a specific feature or resource
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

automation-anywhere-roles-api-openapi.yml Raw ↑

Other APIs Automation Anywhere publishes across the network.

Automation Anywhere Package SDK
automation-anywhere AccessDetails API
automation-anywhere Allocations API
automation-anywhere AttributeValues API
automation-anywhere AuditData API
automation-anywhere Authentication API
automation-anywhere BotRunData API
automation-anywhere Credentials API
automation-anywhere Deployments API
automation-anywhere Files API
automation-anywhere Folders API
automation-anywhere LockerConsumers API
Where this information came from

This is an independent, third-party profile of automation-anywhere Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.