Gainsight CS User Management API — SCIM

naftiko: 1.0.0-alpha2
info:
  label: Gainsight CS User Management API — SCIM
  description: 'Gainsight CS User Management API — SCIM. 5 operations. Lead operation: Gainsight SCIM list users. Self-contained
    Naftiko capability covering one Gainsight business surface.'
  tags:
  - Gainsight
  - SCIM
  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-scim
    baseUri: https://{domain}.gainsightcloud.com/v1
    description: Gainsight CS User Management API — SCIM business capability. Self-contained, no shared references.
    resources:
    - name: scim-v2-Users
      path: /scim/v2/Users
      operations:
      - name: scimlistusers
        method: GET
        description: Gainsight SCIM list users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: SCIM filter expression
        - name: startIndex
          in: query
          type: integer
          description: Starting index
        - name: count
          in: query
          type: integer
          description: Number of records
      - name: scimcreateuser
        method: POST
        description: Gainsight SCIM create user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: scim-v2-Users-scimUserId
      path: /scim/v2/Users/{scimUserId}
      operations:
      - name: scimgetuser
        method: GET
        description: Gainsight SCIM get user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: scimupdateuser
        method: PUT
        description: Gainsight SCIM update user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: scimdeleteuser
        method: DELETE
        description: Gainsight SCIM delete 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-scim-rest
    port: 8080
    description: REST adapter for Gainsight CS User Management API — SCIM. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/scim/v2/users
      name: scim-v2-users
      description: REST surface for scim-v2-Users.
      operations:
      - method: GET
        name: scimlistusers
        description: Gainsight SCIM list users
        call: cs-user-management-scim.scimlistusers
        with:
          filter: rest.filter
          startIndex: rest.startIndex
          count: rest.count
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: scimcreateuser
        description: Gainsight SCIM create user
        call: cs-user-management-scim.scimcreateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/scim/v2/users/{scimuserid}
      name: scim-v2-users-scimuserid
      description: REST surface for scim-v2-Users-scimUserId.
      operations:
      - method: GET
        name: scimgetuser
        description: Gainsight SCIM get user
        call: cs-user-management-scim.scimgetuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: scimupdateuser
        description: Gainsight SCIM update user
        call: cs-user-management-scim.scimupdateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: scimdeleteuser
        description: Gainsight SCIM delete user
        call: cs-user-management-scim.scimdeleteuser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cs-user-management-scim-mcp
    port: 9090
    transport: http
    description: MCP adapter for Gainsight CS User Management API — SCIM. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: gainsight-scim-list-users
      description: Gainsight SCIM list users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-user-management-scim.scimlistusers
      with:
        filter: tools.filter
        startIndex: tools.startIndex
        count: tools.count
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-scim-create-user
      description: Gainsight SCIM create user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cs-user-management-scim.scimcreateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-scim-get-user
      description: Gainsight SCIM get user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cs-user-management-scim.scimgetuser
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-scim-update-user
      description: Gainsight SCIM update user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cs-user-management-scim.scimupdateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gainsight-scim-delete-user
      description: Gainsight SCIM delete user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cs-user-management-scim.scimdeleteuser
      outputParameters:
      - type: object
        mapping: $.