Gainsight CS User Management API — Users

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS User Management API — Users
  description: 'Gainsight CS User Management API — Users. 4 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: cs-user-management-users
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS User Management 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: $.
        inputParameters:
        - name: pageNumber
          in: query
          type: integer
          description: Page number
        - name: pageSize
          in: query
          type: integer
          description: Records per page
    - 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: PUT
        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: users-userId-deactivate
      path: /users/{userId}/deactivate
      operations:
      - name: deactivateuser
        method: POST
        description: Gainsight Deactivate a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: accessKey
      value: '{{env.GAINSIGHT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: cs-user-management-users-rest
    port: 8080
    description: REST adapter for Gainsight CS User Management 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: cs-user-management-users.listusers
        with:
          pageNumber: rest.pageNumber
          pageSize: rest.pageSize
        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: cs-user-management-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: Gainsight Update a user
        call: cs-user-management-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/deactivate
      name: users-userid-deactivate
      description: REST surface for users-userId-deactivate.
      operations:
      - method: POST
        name: deactivateuser
        description: Gainsight Deactivate a user
        call: cs-user-management-users.deactivateuser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-user-management-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS User Management 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: cs-user-management-users.listusers
      with:
        pageNumber: tools.pageNumber
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-get-user
      description: Gainsight Get a user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-user-management-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-update-user
      description: Gainsight Update a user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cs-user-management-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-deactivate-user
      description: Gainsight Deactivate a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cs-user-management-users.deactivateuser
      outputParameters:
      - type: object
        mapping: $.