API Reference — GroupService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — GroupService
  description: 'API Reference — GroupService. 5 operations. Lead operation: GroupService. Self-contained Naftiko capability
    covering one Stackrox business surface.'
  tags:
  - Stackrox
  - GroupService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-groupservice
    baseUri: https://{central-host}
    description: API Reference — GroupService business capability. Self-contained, no shared references.
    resources:
    - name: v1-groups
      path: /v1/groups
      operations:
      - name: getgroup
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: authProviderId
          in: query
          type: string
        - name: key
          in: query
          type: string
        - name: value
          in: query
          type: string
      - name: deletegroup
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: authProviderId
          in: query
          type: string
        - name: key
          in: query
          type: string
        - name: value
          in: query
          type: string
      - name: creategroup
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: updategroup
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-groupsbatch
      path: /v1/groupsbatch
      operations:
      - name: batchupdate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-groupservice-rest
    port: 8080
    description: REST adapter for API Reference — GroupService. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/groups
      name: v1-groups
      description: REST surface for v1-groups.
      operations:
      - method: GET
        name: getgroup
        description: getgroup
        call: stackrox-groupservice.getgroup
        with:
          authProviderId: rest.authProviderId
          key: rest.key
          value: rest.value
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroup
        description: deletegroup
        call: stackrox-groupservice.deletegroup
        with:
          authProviderId: rest.authProviderId
          key: rest.key
          value: rest.value
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategroup
        description: creategroup
        call: stackrox-groupservice.creategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updategroup
        description: updategroup
        call: stackrox-groupservice.updategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/groupsbatch
      name: v1-groupsbatch
      description: REST surface for v1-groupsbatch.
      operations:
      - method: POST
        name: batchupdate
        description: batchupdate
        call: stackrox-groupservice.batchupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-groupservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — GroupService. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: getgroup
      description: getgroup
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-groupservice.getgroup
      with:
        authProviderId: tools.authProviderId
        key: tools.key
        value: tools.value
      outputParameters:
      - type: object
        mapping: $.
    - name: deletegroup
      description: deletegroup
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-groupservice.deletegroup
      with:
        authProviderId: tools.authProviderId
        key: tools.key
        value: tools.value
      outputParameters:
      - type: object
        mapping: $.
    - name: creategroup
      description: creategroup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-groupservice.creategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: updategroup
      description: updategroup
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-groupservice.updategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: batchupdate
      description: batchupdate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-groupservice.batchupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.