InsightIDR API — Users

naftiko: 1.0.0-alpha2
info:
  label: InsightIDR API — Users
  description: 'InsightIDR API — Users. 2 operations. Lead operation: Get user by RRN. Self-contained Naftiko capability covering one business surface.'
  tags:
  - Rapid7
  - Users
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    RAPID7_API_KEY: RAPID7_API_KEY
capability:
  consumes:
  - type: http
    namespace: insightidr-users
    baseUri: https://{region}.api.insight.rapid7.com
    description: InsightIDR API — Users business capability. Self-contained, no shared references.
    resources:
    - name: idr-v1-users-search
      path: /idr/v1/users/_search
      operations:
      - name: searchusers
        method: POST
        description: Search users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: index
          in: query
          type: integer
          description: The optional, 0 based index of the page to retrieve. Must be an integer greater than or equal to 0.
        - name: size
          in: query
          type: integer
          description: The optional size of the page to retrieve. Must be an integer greater than 0 or less than or equal to 1000.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: idr-v1-users-rrn
      path: /idr/v1/users/{rrn}
      operations:
      - name: getuserbyrrn
        method: GET
        description: Get user by RRN
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: rrn
          in: path
          type: string
          description: The RRN of the user.
          required: true
  exposes:
  - type: rest
    namespace: insightidr-users-rest
    port: 8080
    description: REST adapter for InsightIDR API — Users. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/idr/v1/users/_search
      name: idr-v1-users-search
      description: REST surface for idr-v1-users-search.
      operations:
      - method: POST
        name: searchusers
        description: Search users
        call: insightidr-users.searchusers
        with:
          index: rest.index
          size: rest.size
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/idr/v1/users/{rrn}
      name: idr-v1-users-rrn
      description: REST surface for idr-v1-users-rrn.
      operations:
      - method: GET
        name: getuserbyrrn
        description: Get user by RRN
        call: insightidr-users.getuserbyrrn
        with:
          rrn: rest.rrn
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: insightidr-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for InsightIDR API — Users. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: rapid7-searchusers
      description: Search users
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: insightidr-users.searchusers
      with:
        index: tools.index
        size: tools.size
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getuserbyrrn
      description: Get user by RRN
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightidr-users.getuserbyrrn
      with:
        rrn: tools.rrn
      outputParameters:
      - type: object
        mapping: $.