Automation Anywhere · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Automation Anywhere Control Room Users API

6 actions 6 updates phrasing extends openapi/automation-anywhere-users-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/users'].post
$.paths['/v2/usermanagement/users/list'].post
$.paths['/v2/usermanagement/users/{uid}'].get
$.paths['/v2/usermanagement/users/{uid}'].put
$.paths['/v2/usermanagement/users/{uid}'].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 Users API
  version: 1.0.0
extends: openapi/automation-anywhere-users-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/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Control Room user
      effect: write
      questions:
      - How do I add a new user to the Control Room through the API?
      - Can I assign roles and an unattended license when creating a user?
      instructions:
      - text: Create user {username} with email {email} and password {password}.
        slots:
          username: requestBody.username
          email: requestBody.email
          password: requestBody.password
      - text: Add user {username} ({email}, password {password}) with roles {roles}.
        slots:
          username: requestBody.username
          email: requestBody.email
          password: requestBody.password
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/users/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List Control Room users
      effect: read
      questions:
      - Which users are in my Control Room and what roles do they have?
      - Can I search users by email or role?
      instructions:
      - text: List all Control Room users.
      - text: Find users matching {filter}.
        slots:
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/users/{uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's details
      effect: read
      questions:
      - What roles, licenses and account status does a particular user have?
      - Is a specific user account enabled?
      instructions:
      - text: Show user {uid}.
        slots:
          uid: path.uid
      - text: Get the roles and license assignments of user {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/users/{uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's details, roles or status
      effect: write
      questions:
      - Can I disable a user account without deleting it?
      - What happens to existing role assignments when I edit a user's roles?
      instructions:
      - text: Disable user {uid} by setting enabled to {enabled}.
        slots:
          uid: path.uid
          enabled: requestBody.enabled
      - text: Change user {uid}'s roles to {roles}.
        slots:
          uid: path.uid
          roles: requestBody.roles
      - text: Update the email of user {uid} to {email}.
        slots:
          uid: path.uid
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/usermanagement/users/{uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Control Room user
      effect: destructive
      questions:
      - Can a deleted user account be restored?
      - What happens to a user's private bots when I delete the account?
      instructions:
      - text: Delete user {uid}.
        slots:
          uid: path.uid
      - text: Permanently remove Control Room account {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-09-26'