Freshworks Freshchat API — Users

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshchat API — Users
  description: 'Freshworks Freshchat API — Users. 4 operations. Lead operation: List all users. Self-contained Naftiko capability
    covering one Freshworks business surface.'
  tags:
  - Freshworks
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHWORKS_API_KEY: FRESHWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: freshchat-users
    baseUri: https://{domain}.freshchat.com/v2
    description: Freshworks Freshchat API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: List all users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Create 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-user_id
      path: /users/{user_id}
      operations:
      - name: getuser
        method: GET
        description: View a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: Update a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.FRESHWORKS_API_KEY}}'
  exposes:
  - type: rest
    namespace: freshchat-users-rest
    port: 8080
    description: REST adapter for Freshworks Freshchat 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: List all users
        call: freshchat-users.listusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Create a user
        call: freshchat-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{user-id}
      name: users-user-id
      description: REST surface for users-user_id.
      operations:
      - method: GET
        name: getuser
        description: View a user
        call: freshchat-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: Update a user
        call: freshchat-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshchat-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshchat API — Users. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-users
      description: List all users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshchat-users.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: create-user
      description: Create a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshchat-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-user
      description: View a user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshchat-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user
      description: Update a user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshchat-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.