automation-anywhere Permissions API

openapi: 3.1.0
info:
  title: Automation Anywhere API Task Execution AccessDetails Permissions API
  description: The Automation Anywhere API Task Execution API enables developers to invoke API Tasks — a specialized type of cloud-based bot designed to be called synchronously from external applications like a REST service. The API provides endpoints to list API Task allocations, generate unique execution URLs and tokens, and execute API Tasks in real time. API Tasks execute on cloud infrastructure without requiring local Bot Runner devices, and are designed for low latency with near-real-time response rates. The execution URL and authorization token are short-lived and must be refreshed periodically to prevent authorization failures.
  version: '2019'
  contact:
    name: Automation Anywhere Support
    url: https://support.automationanywhere.com
  termsOfService: https://www.automationanywhere.com/terms-of-service
servers:
- url: https://{controlRoomUrl}/orchestrator/v1/hotbot
  description: Automation Anywhere API Task Orchestrator
  variables:
    controlRoomUrl:
      default: your-control-room.automationanywhere.com
      description: Your Control Room hostname
security:
- bearerAuth: []
- xAuthorization: []
tags:
- name: Permissions
  description: Manage role-based permissions on repository folders
paths:
  /role/{roleid}/folder/{folderid}/permissions:
    get:
      operationId: getRolePermissionsForFolder
      summary: View role permissions for a folder
      description: Retrieves the repository permissions granted to a specific role on a specific folder. Returns the set of permitted actions such as view, clone, run, upload, download, and delete.
      tags:
      - Permissions
      parameters:
      - $ref: '#/components/parameters/RoleIdParam'
      - $ref: '#/components/parameters/FolderIdParam'
      responses:
        '200':
          description: Role permissions for the specified folder
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryPermissions'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Role or folder not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /role/{roleid}/permissions:
    put:
      operationId: updateRolePermissions
      summary: Update role permissions
      description: Adds or updates the repository folder permissions granted to a specific role. Permissions are specified as a list of folder-action pairs, enabling fine-grained access control over which operations a role can perform on each folder.
      tags:
      - Permissions
      parameters:
      - $ref: '#/components/parameters/RoleIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PermissionsUpdateRequest'
      responses:
        '200':
          description: Role permissions updated successfully
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Role not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RepositoryPermissions:
      type: object
      description: Permission set for a role on a repository folder
      properties:
        folderId:
          type: integer
          format: int64
          description: Folder ID these permissions apply to
        permissions:
          type: array
          description: List of permitted actions
          items:
            type: string
            enum:
            - clone
            - upload
            - download
            - delete
            - run
            - view
    PermissionsUpdateRequest:
      type: object
      description: Payload to update role permissions across one or more folders
      properties:
        folderPermissions:
          type: array
          description: List of folder permission assignments
          items:
            $ref: '#/components/schemas/RepositoryPermissions'
    Error:
      type: object
      description: Standard error response
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error description
  parameters:
    RoleIdParam:
      name: roleid
      in: path
      required: true
      description: Unique numeric identifier of the role
      schema:
        type: integer
        format: int64
    FolderIdParam:
      name: folderid
      in: path
      required: true
      description: Unique numeric identifier of the folder
      schema:
        type: integer
        format: int64
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from the Authentication API
    xAuthorization:
      type: apiKey
      in: header
      name: X-Authorization
      description: JWT token obtained from the Authentication API
externalDocs:
  description: Automation Anywhere API Task Documentation
  url: https://docs.automationanywhere.com/bundle/enterprise-v2019/page/api-task-real-time-endpoint.html