naftiko: 1.0.0-alpha2
info:
  label: BigID DSAR — Reports
  description: 'BigID DSAR API — Profiles, Attributes, and Reports. 5 operations to inspect profiles and attributes,
    submit DSAR requests, and download short reports. Self-contained Naftiko capability covering one BigID business
    surface.'
  tags:
    - BigID
    - DSAR
    - Privacy
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
  - namespace: env
    keys:
      BIGID_BASE_URL: BIGID_BASE_URL
      BIGID_SYSTEM_TOKEN: BIGID_SYSTEM_TOKEN
capability:
  consumes:
    - type: http
      namespace: dsar-reports
      baseUri: '{{env.BIGID_BASE_URL}}'
      description: BigID DSAR business capability.
      resources:
        - name: sar-profiles
          path: /api/v1/sar/profiles
          operations:
            - name: listdsarprofiles
              method: GET
              description: BigID List DSAR Profiles
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: sar-attributes
          path: /api/v1/sar/attributes
          operations:
            - name: listdsarattributes
              method: GET
              description: BigID List DSAR Attributes
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: profile_id
                  in: query
                  type: string
        - name: sar-reports
          path: /api/v1/sar/reports
          operations:
            - name: createdsarreport
              method: POST
              description: BigID Create A DSAR Report
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  required: true
        - name: sar-report-status
          path: /api/v1/sar/reports/{requestId}/status
          operations:
            - name: getdsarreportstatus
              method: GET
              description: BigID Get DSAR Report Status
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: requestId
                  in: path
                  type: string
                  required: true
        - name: sar-report-short
          path: /api/v1/sar/reports/{requestId}/short-report
          operations:
            - name: getdsarshortreport
              method: GET
              description: BigID Get DSAR Short Report
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: requestId
                  in: path
                  type: string
                  required: true
                - name: format
                  in: query
                  type: string
      authentication:
        type: bearer
        value: '{{env.BIGID_SYSTEM_TOKEN}}'
        placement: header
  exposes:
    - type: rest
      namespace: dsar-reports-rest
      port: 8080
      description: REST adapter for BigID DSAR.
      resources:
        - path: /v1/sar/profiles
          name: sar-profiles
          description: REST surface for sar-profiles.
          operations:
            - method: GET
              name: listdsarprofiles
              description: BigID List DSAR Profiles
              call: dsar-reports.listdsarprofiles
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/sar/attributes
          name: sar-attributes
          description: REST surface for sar-attributes.
          operations:
            - method: GET
              name: listdsarattributes
              description: BigID List DSAR Attributes
              call: dsar-reports.listdsarattributes
              with:
                profile_id: rest.query.profile_id
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/sar/reports
          name: sar-reports
          description: REST surface for sar-reports.
          operations:
            - method: POST
              name: createdsarreport
              description: BigID Create A DSAR Report
              call: dsar-reports.createdsarreport
              with:
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/sar/reports/{requestId}/status
          name: sar-report-status
          description: REST surface for sar-report-status.
          operations:
            - method: GET
              name: getdsarreportstatus
              description: BigID Get DSAR Report Status
              call: dsar-reports.getdsarreportstatus
              with:
                requestId: rest.path.requestId
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/sar/reports/{requestId}/short-report
          name: sar-report-short
          description: REST surface for sar-report-short.
          operations:
            - method: GET
              name: getdsarshortreport
              description: BigID Get DSAR Short Report
              call: dsar-reports.getdsarshortreport
              with:
                requestId: rest.path.requestId
                format: rest.query.format
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: dsar-reports-mcp
      port: 9090
      transport: http
      description: MCP adapter for BigID DSAR.
      tools:
        - name: bigid-list-dsar-profiles
          description: BigID List DSAR Profiles
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: dsar-reports.listdsarprofiles
          outputParameters:
            - type: object
              mapping: $.
        - name: bigid-list-dsar-attributes
          description: BigID List DSAR Attributes
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: dsar-reports.listdsarattributes
          with:
            profile_id: tools.profile_id
          outputParameters:
            - type: object
              mapping: $.
        - name: bigid-create-dsar-report
          description: BigID Create A DSAR Report
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: dsar-reports.createdsarreport
          with:
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: bigid-get-dsar-report-status
          description: BigID Get DSAR Report Status
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: dsar-reports.getdsarreportstatus
          with:
            requestId: tools.requestId
          outputParameters:
            - type: object
              mapping: $.
        - name: bigid-get-dsar-short-report
          description: BigID Get DSAR Short Report
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: dsar-reports.getdsarshortreport
          with:
            requestId: tools.requestId
            format: tools.format
          outputParameters:
            - type: object
              mapping: $.