Gainsight PX API — Users

naftiko: 1.0.0-alpha2
info:
  label: Gainsight PX API — Users
  description: 'Gainsight PX API — Users. 5 operations. Lead operation: Gainsight List users. Self-contained Naftiko capability
    covering one Gainsight business surface.'
  tags:
  - Gainsight
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GAINSIGHT_API_KEY: GAINSIGHT_API_KEY
capability:
  consumes:
  - type: http
    namespace: px-users
    baseUri: https://api.aptrinsic.com/v1
    description: Gainsight PX API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: Gainsight List users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Gainsight Create or update a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-userId
      path: /users/{userId}
      operations:
      - name: getuser
        method: GET
        description: Gainsight Get a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PATCH
        description: Gainsight Update a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteuser
        method: DELETE
        description: Gainsight Delete a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-APTRINSIC-API-KEY
      value: '{{env.GAINSIGHT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: px-users-rest
    port: 8080
    description: REST adapter for Gainsight PX API — Users. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for users.
      operations:
      - method: GET
        name: listusers
        description: Gainsight List users
        call: px-users.listusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Gainsight Create or update a user
        call: px-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}
      name: users-userid
      description: REST surface for users-userId.
      operations:
      - method: GET
        name: getuser
        description: Gainsight Get a user
        call: px-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateuser
        description: Gainsight Update a user
        call: px-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Gainsight Delete a user
        call: px-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: px-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight PX API — Users. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: gainsight-list-users
      description: Gainsight List users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: px-users.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-create-update-user
      description: Gainsight Create or update a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: px-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-get-user
      description: Gainsight Get a user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: px-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-update-user
      description: Gainsight Update a user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: px-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-delete-user
      description: Gainsight Delete a user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: px-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.