Spiceworks Cloud Apps API — Users

naftiko: 1.0.0-alpha2
info:
  label: Spiceworks Cloud Apps API — Users
  description: 'Spiceworks Cloud Apps API — Users. 2 operations. Lead operation: List Platform Users. Self-contained Naftiko
    capability covering one Spiceworks business surface.'
  tags:
  - Spiceworks
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SPICEWORKS_API_KEY: SPICEWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-apps-users
    baseUri: https://community.spiceworks.com
    description: Spiceworks Cloud Apps API — Users business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-users
      path: /api/v1/users
      operations:
      - name: listusers
        method: GET
        description: List Platform Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: role
          in: query
          type: string
          description: Filter by user role
        - name: page
          in: query
          type: integer
          description: Page number for pagination
    - name: api-v1-users-id
      path: /api/v1/users/{id}
      operations:
      - name: getuser
        method: GET
        description: Get Platform User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The unique identifier of the user
          required: true
    authentication:
      type: bearer
      token: '{{env.SPICEWORKS_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-apps-users-rest
    port: 8080
    description: REST adapter for Spiceworks Cloud Apps API — Users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/users
      name: api-v1-users
      description: REST surface for api-v1-users.
      operations:
      - method: GET
        name: listusers
        description: List Platform Users
        call: cloud-apps-users.listusers
        with:
          role: rest.role
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/users/{id}
      name: api-v1-users-id
      description: REST surface for api-v1-users-id.
      operations:
      - method: GET
        name: getuser
        description: Get Platform User
        call: cloud-apps-users.getuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-apps-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Spiceworks Cloud Apps API — Users. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-platform-users
      description: List Platform Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-apps-users.listusers
      with:
        role: tools.role
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: get-platform-user
      description: Get Platform User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-apps-users.getuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.