Endpoints — subpackage_users

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_users
  description: 'Endpoints — subpackage_users. 3 operations. Lead operation: List users. Self-contained Naftiko capability
    covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DEEL_API_KEY: DEEL_API_KEY
capability:
  consumes:
  - type: http
    namespace: custom-fields-endpoints-subpackage-users
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_users business capability. Self-contained, no shared references.
    resources:
    - name: Users
      path: /Users
      operations:
      - name: getusers
        method: GET
        description: List users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Filter results using [SCIM's filtering syntax](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).
            Currently supports only `eq` operator and filteri
        - name: startIndex
          in: query
          type: string
          description: The 1-based index of the first result to return. Used for pagination. Minimum value is 1. Defaults
            to 1 if not provided.
        - name: count
          in: query
          type: string
          description: The maximum number of results to return per page. Used for pagination. A value of 0 is treated as a
            special case and returns 1 result. Typically should be a pos
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: Users-.search
      path: /Users/.search
      operations:
      - name: searchusers
        method: POST
        description: Search or list users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: Users-hrisProfileOid
      path: /Users/{hrisProfileOid}
      operations:
      - name: getuserbyid
        method: GET
        description: Retrieve a single User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: hrisProfileOid
          in: path
          type: string
          description: Retrieve a single user by id.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    authentication:
      type: bearer
      token: '{{env.DEEL_API_KEY}}'
  exposes:
  - type: rest
    namespace: custom-fields-endpoints-subpackage-users-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_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: getusers
        description: List users
        call: custom-fields-endpoints-subpackage-users.getusers
        with:
          filter: rest.filter
          startIndex: rest.startIndex
          count: rest.count
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/search
      name: users-search
      description: REST surface for Users-.search.
      operations:
      - method: POST
        name: searchusers
        description: Search or list users
        call: custom-fields-endpoints-subpackage-users.searchusers
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{hrisprofileoid}
      name: users-hrisprofileoid
      description: REST surface for Users-hrisProfileOid.
      operations:
      - method: GET
        name: getuserbyid
        description: Retrieve a single User
        call: custom-fields-endpoints-subpackage-users.getuserbyid
        with:
          hrisProfileOid: rest.hrisProfileOid
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: custom-fields-endpoints-subpackage-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-users
      description: List users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: custom-fields-endpoints-subpackage-users.getusers
      with:
        filter: tools.filter
        startIndex: tools.startIndex
        count: tools.count
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: search-list-users
      description: Search or list users
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: custom-fields-endpoints-subpackage-users.searchusers
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-single-user
      description: Retrieve a single User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: custom-fields-endpoints-subpackage-users.getuserbyid
      with:
        hrisProfileOid: tools.hrisProfileOid
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.