Automation Anywhere · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Automation Anywhere Control Room Roles API

6 actions 6 updates phrasing extends openapi/automation-anywhere-roles-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Automation Anywhere's API. It is a proposal applied on top of the contract, not a document Automation Anywhere publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v2/usermanagement/roles'].post
$.paths['/v2/usermanagement/roles/list'].post
$.paths['/v2/usermanagement/roles/{id}'].get
$.paths['/v2/usermanagement/roles/{id}'].put
$.paths['/v2/usermanagement/roles/{id}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Automation Anywhere Control Room Roles API
  version: 1.0.0
extends: openapi/automation-anywhere-roles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v2/usermanagement/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Control Room role
      effect: write
      questions:
      - How do I create a new role with its own set of permissions?
      - Can I define a role's permissions at the moment I create it?
      instructions:
      - text: Create a role named {name}.
        slots:
          name: requestBody.name
      - text: Create role {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/roles/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List Control Room roles
      effect: read
      questions:
      - Which roles exist in my Control Room?
      - Can I filter roles by name and choose which fields come back?
      instructions:
      - text: List all Control Room roles.
      - text: Find roles matching {filter}.
        slots:
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's details and members
      effect: read
      questions:
      - What permissions does a specific role grant?
      - Which users are assigned to a given role?
      instructions:
      - text: Show role {id}.
        slots:
          id: path.id
      - text: List the permissions and assigned users of role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/roles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a role's name or permissions
      effect: write
      questions:
      - Can I change the permissions of an existing role?
      - Do edits to a role apply right away to everyone assigned it?
      instructions:
      - text: Replace the permissions of role {id} with {permissions}.
        slots:
          id: path.id
          permissions: requestBody.permissions
      - text: Rename role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Control Room role
      effect: destructive
      questions:
      - Can I delete a custom role, and what happens to its users?
      - Which built-in roles can't be deleted?
      instructions:
      - text: Delete role {id}.
        slots:
          id: path.id
      - text: Permanently remove Control Room role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'