Zendesk Support API — Users

naftiko: 1.0.0-alpha2
info:
  label: Zendesk Support API — Users
  description: 'Zendesk Support API — Users. 6 operations. Lead operation: Zendesk List Users. Self-contained Naftiko capability
    covering one Zendesk business surface.'
  tags:
  - Zendesk
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZENDESK_API_KEY: ZENDESK_API_KEY
capability:
  consumes:
  - type: http
    namespace: support-users
    baseUri: https://{subdomain}.zendesk.com/api/v2
    description: Zendesk Support API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: Zendesk List Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: role
          in: query
          type: string
          description: Filter by user role.
        - name: permission_set
          in: query
          type: integer
          description: For custom roles, filter by the permission set ID.
      - name: createuser
        method: POST
        description: Zendesk Create User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-search
      path: /users/search
      operations:
      - name: searchusers
        method: GET
        description: Zendesk Search Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: The search query. Supports name, email, phone, external_id, and other fields.
          required: true
    - name: users-user_id
      path: /users/{user_id}
      operations:
      - name: getuser
        method: GET
        description: Zendesk Show User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: Zendesk Update 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: Zendesk Delete User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ZENDESK_API_KEY}}'
  exposes:
  - type: rest
    namespace: support-users-rest
    port: 8080
    description: REST adapter for Zendesk Support 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: Zendesk List Users
        call: support-users.listusers
        with:
          role: rest.role
          permission_set: rest.permission_set
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Zendesk Create User
        call: support-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/search
      name: users-search
      description: REST surface for users-search.
      operations:
      - method: GET
        name: searchusers
        description: Zendesk Search Users
        call: support-users.searchusers
        with:
          query: rest.query
        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: Zendesk Show User
        call: support-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: Zendesk Update User
        call: support-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Zendesk Delete User
        call: support-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: support-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Zendesk Support API — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: zendesk-list-users
      description: Zendesk List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: support-users.listusers
      with:
        role: tools.role
        permission_set: tools.permission_set
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-create-user
      description: Zendesk Create User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: support-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-search-users
      description: Zendesk Search Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: support-users.searchusers
      with:
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-show-user
      description: Zendesk Show User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: support-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-update-user
      description: Zendesk Update User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: support-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: zendesk-delete-user
      description: Zendesk Delete User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: support-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.