Automation Anywhere · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Automation Anywhere Credential Vault Locker Consumers API

4 actions 4 updates phrasing extends openapi/automation-anywhere-lockerconsumers-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 4

$.info

$.paths['/lockers/{id}/consumers'].get

$.paths['/lockers/{id}/consumers'].post

$.paths['/lockers/{id}/consumers/{roleId}'].delete

OpenAPI Overlay

# 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 Credential Vault Locker Consumers API
  version: 1.0.0
extends: openapi/automation-anywhere-lockerconsumers-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: 3
- target: $.paths['/lockers/{id}/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles with consumer access to a locker
      effect: read
      questions:
      - Which roles can let bots use the credentials in a given Locker?
      - Who are the consumers of this Locker?
      instructions:
      - text: List the consumer roles of locker {id}.
        slots:
          id: path.id
      - text: Show which roles consume credentials from locker {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/{id}/consumers'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a role consumer access to a locker
      effect: write
      questions:
      - How do I let bots under a role retrieve credentials from a Locker?
      - Can I add a role as a consumer of a Locker?
      instructions:
      - text: Add role {roleId} as a consumer of locker {id}.
        slots:
          roleId: requestBody.roleId
          id: path.id
      - text: Give bots in role {roleId} access to the credentials in locker {id}.
        slots:
          roleId: requestBody.roleId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lockers/{id}/consumers/{roleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a role's consumer access to a locker
      effect: destructive
      questions:
      - Can I stop a role's bots from pulling credentials out of a Locker?
      - What happens to bots when their role is removed as a Locker consumer?
      instructions:
      - text: Remove role {roleId} as a consumer of locker {id}.
        slots:
          roleId: path.roleId
          id: path.id
      - text: Revoke consumer access for role {roleId} on locker {id}.
        slots:
          roleId: path.roleId
          id: path.id
      method: generated
      generated: '2026-09-26'