BeyondTrust Password Safe API — Requests

naftiko: 1.0.0-alpha2
info:
  label: BeyondTrust Password Safe API — Requests
  description: 'BeyondTrust Password Safe API — Requests. 5 operations. Lead operation: BeyondTrust List Requests. Self-contained
    Naftiko capability covering one Beyondtrust business surface.'
  tags:
  - Beyondtrust
  - Requests
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BEYONDTRUST_API_KEY: BEYONDTRUST_API_KEY
capability:
  consumes:
  - type: http
    namespace: password-safe-requests
    baseUri: https://{hostname}/BeyondTrust/api/public/v3
    description: BeyondTrust Password Safe API — Requests business capability. Self-contained, no shared references.
    resources:
    - name: requests
      path: /requests
      operations:
      - name: listrequests
        method: GET
        description: BeyondTrust List Requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createrequest
        method: POST
        description: BeyondTrust Create Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: requests-requestId
      path: /requests/{requestId}
      operations:
      - name: getrequest
        method: GET
        description: BeyondTrust Get Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: requestId
          in: path
          type: integer
          description: The unique identifier of the request.
          required: true
      - name: updaterequest
        method: PUT
        description: BeyondTrust Update Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: requestId
          in: path
          type: integer
          description: The unique identifier of the request.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterequest
        method: DELETE
        description: BeyondTrust Delete Request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: requestId
          in: path
          type: integer
          description: The unique identifier of the request.
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.BEYONDTRUST_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: password-safe-requests-rest
    port: 8080
    description: REST adapter for BeyondTrust Password Safe API — Requests. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/requests
      name: requests
      description: REST surface for requests.
      operations:
      - method: GET
        name: listrequests
        description: BeyondTrust List Requests
        call: password-safe-requests.listrequests
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrequest
        description: BeyondTrust Create Request
        call: password-safe-requests.createrequest
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/requests/{requestid}
      name: requests-requestid
      description: REST surface for requests-requestId.
      operations:
      - method: GET
        name: getrequest
        description: BeyondTrust Get Request
        call: password-safe-requests.getrequest
        with:
          requestId: rest.requestId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterequest
        description: BeyondTrust Update Request
        call: password-safe-requests.updaterequest
        with:
          requestId: rest.requestId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterequest
        description: BeyondTrust Delete Request
        call: password-safe-requests.deleterequest
        with:
          requestId: rest.requestId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: password-safe-requests-mcp
    port: 9090
    transport: http
    description: MCP adapter for BeyondTrust Password Safe API — Requests. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: beyondtrust-list-requests
      description: BeyondTrust List Requests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: password-safe-requests.listrequests
      outputParameters:
      - type: object
        mapping: $.
    - name: beyondtrust-create-request
      description: BeyondTrust Create Request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: password-safe-requests.createrequest
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: beyondtrust-get-request
      description: BeyondTrust Get Request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: password-safe-requests.getrequest
      with:
        requestId: tools.requestId
      outputParameters:
      - type: object
        mapping: $.
    - name: beyondtrust-update-request
      description: BeyondTrust Update Request
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: password-safe-requests.updaterequest
      with:
        requestId: tools.requestId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: beyondtrust-delete-request
      description: BeyondTrust Delete Request
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: password-safe-requests.deleterequest
      with:
        requestId: tools.requestId
      outputParameters:
      - type: object
        mapping: $.