InsightVM API — Credential

naftiko: 1.0.0-alpha2
info:
  label: InsightVM API — Credential
  description: 'InsightVM API — Credential. 6 operations. Lead operation: Shared Credentials. Self-contained Naftiko capability covering one business surface.'
  tags:
  - Rapid7
  - Credential
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    RAPID7_API_KEY: RAPID7_API_KEY
capability:
  consumes:
  - type: http
    namespace: insightvm-console-swagger-credential
    baseUri: https://localhost:3780
    description: InsightVM API — Credential business capability. Self-contained, no shared references.
    resources:
    - name: api-3-shared-credentials
      path: /api/3/shared_credentials
      operations:
      - name: getsharedcredentials
        method: GET
        description: Shared Credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
      - name: createsharedcredential
        method: POST
        description: Shared Credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: credential
          in: body
          type: string
          description: The specification of a shared credential.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteallsharedcredentials
        method: DELETE
        description: Shared Credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: api-3-shared-credentials-id
      path: /api/3/shared_credentials/{id}
      operations:
      - name: getsharedcredential
        method: GET
        description: Shared Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the credential.
          required: true
      - name: updatesharedcredential
        method: PUT
        description: Shared Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the credential.
          required: true
        - name: credential
          in: body
          type: string
          description: The specification of the shared credential to update.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletesharedcredential
        method: DELETE
        description: Shared Credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the credential.
          required: true
  exposes:
  - type: rest
    namespace: insightvm-console-swagger-credential-rest
    port: 8080
    description: REST adapter for InsightVM API — Credential. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/shared_credentials
      name: api-3-shared-credentials
      description: REST surface for api-3-shared-credentials.
      operations:
      - method: GET
        name: getsharedcredentials
        description: Shared Credentials
        call: insightvm-console-swagger-credential.getsharedcredentials
        with: {}
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsharedcredential
        description: Shared Credentials
        call: insightvm-console-swagger-credential.createsharedcredential
        with:
          credential: rest.credential
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteallsharedcredentials
        description: Shared Credentials
        call: insightvm-console-swagger-credential.deleteallsharedcredentials
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/shared_credentials/{id}
      name: api-3-shared-credentials-id
      description: REST surface for api-3-shared-credentials-id.
      operations:
      - method: GET
        name: getsharedcredential
        description: Shared Credential
        call: insightvm-console-swagger-credential.getsharedcredential
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesharedcredential
        description: Shared Credential
        call: insightvm-console-swagger-credential.updatesharedcredential
        with:
          id: rest.id
          credential: rest.credential
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesharedcredential
        description: Shared Credential
        call: insightvm-console-swagger-credential.deletesharedcredential
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: insightvm-console-swagger-credential-mcp
    port: 9090
    transport: http
    description: MCP adapter for InsightVM API — Credential. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: rapid7-getsharedcredentials
      description: Shared Credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-credential.getsharedcredentials
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-createsharedcredential
      description: Shared Credentials
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: insightvm-console-swagger-credential.createsharedcredential
      with:
        credential: tools.credential
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-deleteallsharedcredentials
      description: Shared Credentials
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: insightvm-console-swagger-credential.deleteallsharedcredentials
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getsharedcredential
      description: Shared Credential
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-credential.getsharedcredential
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-updatesharedcredential
      description: Shared Credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-credential.updatesharedcredential
      with:
        id: tools.id
        credential: tools.credential
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-deletesharedcredential
      description: Shared Credential
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: insightvm-console-swagger-credential.deletesharedcredential
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.