# 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 Credentials API
  version: 1.0.0
extends: openapi/automation-anywhere-credentials-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: 6
- target: $.paths['/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credential in the Credential Vault
      effect: write
      questions:
      - How do I add a new username and password credential to the Credential Vault?
      - Can I define the attribute fields of a credential when I first create it?
      instructions:
      - text: Create a credential named {name} in the Credential Vault.
        slots:
          name: requestBody.name
      - text: Create credential {name} described as {description} with attributes {attributes}.
        slots:
          name: requestBody.name
          description: requestBody.description
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search credentials I own or can access
      effect: read
      questions:
      - Which credentials do I own or have access to through a Locker?
      - Can I search the Credential Vault by name and sort the results?
      - Do credential search results include the secret values?
      instructions:
      - text: Search my credentials matching {filter}.
        slots:
          filter: requestBody.filter
      - text: List every credential I can access, sorted by {sort}.
        slots:
          sort: requestBody.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential and its attributes
      effect: read
      questions:
      - What attributes and current values does a specific credential have?
      - Can I fetch a credential's values in the format a bot consumes them?
      instructions:
      - text: Show credential {id} with its attributes.
        slots:
          id: path.id
      - text: Fetch credential {id} in bot-consumption format ({consumed}).
        slots:
          id: path.id
          consumed: query.consumed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redefine a credential
      effect: write
      questions:
      - Can I rename a credential or change its description after creating it?
      - What happens to attributes I leave out when I edit a credential's definition?
      instructions:
      - text: Rename credential {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Replace the attribute definitions on credential {id} with {attributes}.
        slots:
          id: path.id
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential from the Credential Vault
      effect: destructive
      questions:
      - Can I permanently delete a credential and all its stored values?
      - Why can't I delete a credential that is still in a Locker?
      instructions:
      - text: Delete credential {id} from the Credential Vault.
        slots:
          id: path.id
      - text: Permanently remove credential {id} and all its attribute values.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{id}/owner/{credentialOwnerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Transfer a credential to a new owner
      effect: write
      questions:
      - Can I hand ownership of a credential over to another user?
      - What control does a new credential owner get after a transfer?
      instructions:
      - text: Transfer ownership of credential {id} to user {credentialOwnerId}.
        slots:
          id: path.id
          credentialOwnerId: path.credentialOwnerId
      - text: Make user {credentialOwnerId} the owner of credential {id}.
        slots:
          credentialOwnerId: path.credentialOwnerId
          id: path.id
      method: generated
      generated: '2026-09-26'