Automation Anywhere Credential Vault API — Credentials

naftiko: 1.0.0-alpha2
info:
  label: Automation Anywhere Credential Vault API — Credentials
  description: 'Automation Anywhere Credential Vault API — Credentials. 6 operations. Lead operation: Create a credential.
    Self-contained Naftiko capability covering one Automation Anywhere business surface.'
  tags:
  - Automation Anywhere
  - Credentials
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AUTOMATION_ANYWHERE_API_KEY: AUTOMATION_ANYWHERE_API_KEY
capability:
  consumes:
  - type: http
    namespace: credential-vault-credentials
    baseUri: https://{controlRoomUrl}/v2/credentialvault
    description: Automation Anywhere Credential Vault API — Credentials business capability. Self-contained, no shared references.
    resources:
    - name: credentials
      path: /credentials
      operations:
      - name: createcredential
        method: POST
        description: Create a credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: credentials-list
      path: /credentials/list
      operations:
      - name: listcredentials
        method: POST
        description: Search credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: credentials-id
      path: /credentials/{id}
      operations:
      - name: getcredential
        method: GET
        description: Get a credential by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecredential
        method: PUT
        description: Update a credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecredential
        method: DELETE
        description: Delete a credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: credentials-id-owner-credentialOwnerId
      path: /credentials/{id}/owner/{credentialOwnerId}
      operations:
      - name: updatecredentialowner
        method: PUT
        description: Update credential ownership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: credentialOwnerId
          in: path
          type: integer
          description: Numeric ID of the user who will become the new credential owner
          required: true
    authentication:
      type: bearer
      token: '{{env.AUTOMATION_ANYWHERE_API_KEY}}'
  exposes:
  - type: rest
    namespace: credential-vault-credentials-rest
    port: 8080
    description: REST adapter for Automation Anywhere Credential Vault API — Credentials. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/credentials
      name: credentials
      description: REST surface for credentials.
      operations:
      - method: POST
        name: createcredential
        description: Create a credential
        call: credential-vault-credentials.createcredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/list
      name: credentials-list
      description: REST surface for credentials-list.
      operations:
      - method: POST
        name: listcredentials
        description: Search credentials
        call: credential-vault-credentials.listcredentials
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/{id}
      name: credentials-id
      description: REST surface for credentials-id.
      operations:
      - method: GET
        name: getcredential
        description: Get a credential by ID
        call: credential-vault-credentials.getcredential
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecredential
        description: Update a credential
        call: credential-vault-credentials.updatecredential
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecredential
        description: Delete a credential
        call: credential-vault-credentials.deletecredential
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/credentials/{id}/owner/{credentialownerid}
      name: credentials-id-owner-credentialownerid
      description: REST surface for credentials-id-owner-credentialOwnerId.
      operations:
      - method: PUT
        name: updatecredentialowner
        description: Update credential ownership
        call: credential-vault-credentials.updatecredentialowner
        with:
          credentialOwnerId: rest.credentialOwnerId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: credential-vault-credentials-mcp
    port: 9090
    transport: http
    description: MCP adapter for Automation Anywhere Credential Vault API — Credentials. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: create-credential
      description: Create a credential
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: credential-vault-credentials.createcredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-credentials
      description: Search credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: credential-vault-credentials.listcredentials
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-credential-id
      description: Get a credential by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: credential-vault-credentials.getcredential
      outputParameters:
      - type: object
        mapping: $.
    - name: update-credential
      description: Update a credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: credential-vault-credentials.updatecredential
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-credential
      description: Delete a credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: credential-vault-credentials.deletecredential
      outputParameters:
      - type: object
        mapping: $.
    - name: update-credential-ownership
      description: Update credential ownership
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: credential-vault-credentials.updatecredentialowner
      with:
        credentialOwnerId: tools.credentialOwnerId
      outputParameters:
      - type: object
        mapping: $.