Workday Benefits API — Benefit Enrollments

naftiko: 1.0.0-alpha2
info:
  label: Workday Benefits API — Benefit Enrollments
  description: 'Workday Benefits API — Benefit Enrollments. 3 operations. Lead operation: Workday List Benefit Enrollments.
    Self-contained Naftiko capability covering one Workday Benefits business surface.'
  tags:
  - Workday Benefits
  - Benefit Enrollments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_BENEFITS_API_KEY: WORKDAY_BENEFITS_API_KEY
capability:
  consumes:
  - type: http
    namespace: workday-benefits-benefit-enrollments
    baseUri: https://{tenant}.workday.com/api/benefits/v1
    description: Workday Benefits API — Benefit Enrollments business capability. Self-contained, no shared references.
    resources:
    - name: benefitEnrollments
      path: /benefitEnrollments
      operations:
      - name: listbenefitenrollments
        method: GET
        description: Workday List Benefit Enrollments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of records to return
        - name: offset
          in: query
          type: integer
          description: Number of records to skip
        - name: employeeId
          in: query
          type: string
          description: Filter enrollments by employee ID
        - name: planId
          in: query
          type: string
          description: Filter enrollments by benefit plan ID
      - name: createbenefitenrollment
        method: POST
        description: Workday Create Benefit Enrollment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: benefitEnrollments-enrollmentId
      path: /benefitEnrollments/{enrollmentId}
      operations:
      - name: getbenefitenrollment
        method: GET
        description: Workday Get Benefit Enrollment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: enrollmentId
          in: path
          type: string
          description: Benefit enrollment identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.WORKDAY_BENEFITS_API_KEY}}'
  exposes:
  - type: rest
    namespace: workday-benefits-benefit-enrollments-rest
    port: 8080
    description: REST adapter for Workday Benefits API — Benefit Enrollments. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/benefitenrollments
      name: benefitenrollments
      description: REST surface for benefitEnrollments.
      operations:
      - method: GET
        name: listbenefitenrollments
        description: Workday List Benefit Enrollments
        call: workday-benefits-benefit-enrollments.listbenefitenrollments
        with:
          limit: rest.limit
          offset: rest.offset
          employeeId: rest.employeeId
          planId: rest.planId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbenefitenrollment
        description: Workday Create Benefit Enrollment
        call: workday-benefits-benefit-enrollments.createbenefitenrollment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/benefitenrollments/{enrollmentid}
      name: benefitenrollments-enrollmentid
      description: REST surface for benefitEnrollments-enrollmentId.
      operations:
      - method: GET
        name: getbenefitenrollment
        description: Workday Get Benefit Enrollment
        call: workday-benefits-benefit-enrollments.getbenefitenrollment
        with:
          enrollmentId: rest.enrollmentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: workday-benefits-benefit-enrollments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Benefits API — Benefit Enrollments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: workday-list-benefit-enrollments
      description: Workday List Benefit Enrollments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workday-benefits-benefit-enrollments.listbenefitenrollments
      with:
        limit: tools.limit
        offset: tools.offset
        employeeId: tools.employeeId
        planId: tools.planId
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-create-benefit-enrollment
      description: Workday Create Benefit Enrollment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workday-benefits-benefit-enrollments.createbenefitenrollment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-get-benefit-enrollment
      description: Workday Get Benefit Enrollment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workday-benefits-benefit-enrollments.getbenefitenrollment
      with:
        enrollmentId: tools.enrollmentId
      outputParameters:
      - type: object
        mapping: $.