UKG Pro HCM API — Benefits

naftiko: 1.0.0-alpha2
info:
  label: UKG Pro HCM API — Benefits
  description: 'UKG Pro HCM API — Benefits. 1 operations. Lead operation: UKG Pro HCM Get Employee Benefits Elections. Self-contained
    Naftiko capability covering one Ukg business surface.'
  tags:
  - Ukg
  - Benefits
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UKG_API_KEY: UKG_API_KEY
capability:
  consumes:
  - type: http
    namespace: pro-hcm-benefits
    baseUri: https://service.ultipro.com
    description: UKG Pro HCM API — Benefits business capability. Self-contained, no shared references.
    resources:
    - name: personnel-v2-employees-employeeId-benefits-elections
      path: /personnel/v2/employees/{employeeId}/benefits-elections
      operations:
      - name: getemployeebenefitselections
        method: GET
        description: UKG Pro HCM Get Employee Benefits Elections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: employeeId
          in: path
          type: string
          description: Employee identifier
          required: true
    authentication:
      type: basic
      username: '{{env.UKG_USER}}'
      password: '{{env.UKG_PASS}}'
  exposes:
  - type: rest
    namespace: pro-hcm-benefits-rest
    port: 8080
    description: REST adapter for UKG Pro HCM API — Benefits. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/personnel/v2/employees/{employeeid}/benefits-elections
      name: personnel-v2-employees-employeeid-benefits-elections
      description: REST surface for personnel-v2-employees-employeeId-benefits-elections.
      operations:
      - method: GET
        name: getemployeebenefitselections
        description: UKG Pro HCM Get Employee Benefits Elections
        call: pro-hcm-benefits.getemployeebenefitselections
        with:
          employeeId: rest.employeeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pro-hcm-benefits-mcp
    port: 9090
    transport: http
    description: MCP adapter for UKG Pro HCM API — Benefits. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: ukg-pro-hcm-get-employee
      description: UKG Pro HCM Get Employee Benefits Elections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-benefits.getemployeebenefitselections
      with:
        employeeId: tools.employeeId
      outputParameters:
      - type: object
        mapping: $.