Box Groups API — Groups

naftiko: 1.0.0-alpha2
info:
  label: Box Groups API — Groups
  description: 'Box Groups API — Groups. 8 operations. Lead operation: Box List groups for enterprise. Self-contained Naftiko
    capability covering one Box business surface.'
  tags:
  - Box
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BOX_API_KEY: BOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: groups-groups
    baseUri: ''
    description: Box Groups API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: groups
      path: /groups
      operations:
      - name: getgroups
        method: GET
        description: Box List groups for enterprise
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter_term
          in: query
          type: string
          description: Limits the results to only groups whose `name` starts
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: offset
          in: query
          type: integer
          description: The offset of the item at which to begin the response.
      - name: postgroups
        method: POST
        description: Box Create group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: groups-terminate_sessions
      path: /groups/terminate_sessions
      operations:
      - name: postgroupsterminatesessions
        method: POST
        description: Box Create jobs to terminate user group session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: groups-group_id
      path: /groups/{group_id}
      operations:
      - name: getgroupsid
        method: GET
        description: Box Get group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The ID of the group.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
      - name: putgroupsid
        method: PUT
        description: Box Update group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The ID of the group.
          required: true
        - name: fields
          in: query
          type: array
          description: A comma-separated list of attributes to include in the
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletegroupsid
        method: DELETE
        description: Box Remove group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The ID of the group.
          required: true
    - name: groups-group_id-collaborations
      path: /groups/{group_id}/collaborations
      operations:
      - name: getgroupsidcollaborations
        method: GET
        description: Box List group collaborations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The ID of the group.
          required: true
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: offset
          in: query
          type: integer
          description: The offset of the item at which to begin the response.
    - name: groups-group_id-memberships
      path: /groups/{group_id}/memberships
      operations:
      - name: getgroupsidmemberships
        method: GET
        description: Box List members of group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: group_id
          in: path
          type: string
          description: The ID of the group.
          required: true
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: offset
          in: query
          type: integer
          description: The offset of the item at which to begin the response.
  exposes:
  - type: rest
    namespace: groups-groups-rest
    port: 8080
    description: REST adapter for Box Groups API — Groups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/groups
      name: groups
      description: REST surface for groups.
      operations:
      - method: GET
        name: getgroups
        description: Box List groups for enterprise
        call: groups-groups.getgroups
        with:
          filter_term: rest.filter_term
          fields: rest.fields
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postgroups
        description: Box Create group
        call: groups-groups.postgroups
        with:
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/terminate-sessions
      name: groups-terminate-sessions
      description: REST surface for groups-terminate_sessions.
      operations:
      - method: POST
        name: postgroupsterminatesessions
        description: Box Create jobs to terminate user group session
        call: groups-groups.postgroupsterminatesessions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{group-id}
      name: groups-group-id
      description: REST surface for groups-group_id.
      operations:
      - method: GET
        name: getgroupsid
        description: Box Get group
        call: groups-groups.getgroupsid
        with:
          group_id: rest.group_id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putgroupsid
        description: Box Update group
        call: groups-groups.putgroupsid
        with:
          group_id: rest.group_id
          fields: rest.fields
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroupsid
        description: Box Remove group
        call: groups-groups.deletegroupsid
        with:
          group_id: rest.group_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{group-id}/collaborations
      name: groups-group-id-collaborations
      description: REST surface for groups-group_id-collaborations.
      operations:
      - method: GET
        name: getgroupsidcollaborations
        description: Box List group collaborations
        call: groups-groups.getgroupsidcollaborations
        with:
          group_id: rest.group_id
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{group-id}/memberships
      name: groups-group-id-memberships
      description: REST surface for groups-group_id-memberships.
      operations:
      - method: GET
        name: getgroupsidmemberships
        description: Box List members of group
        call: groups-groups.getgroupsidmemberships
        with:
          group_id: rest.group_id
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: groups-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Box Groups API — Groups. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: box-list-groups-enterprise
      description: Box List groups for enterprise
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: groups-groups.getgroups
      with:
        filter_term: tools.filter_term
        fields: tools.fields
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: box-create-group
      description: Box Create group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: groups-groups.postgroups
      with:
        fields: tools.fields
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: box-create-jobs-terminate-user
      description: Box Create jobs to terminate user group session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: groups-groups.postgroupsterminatesessions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: box-get-group
      description: Box Get group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: groups-groups.getgroupsid
      with:
        group_id: tools.group_id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: box-update-group
      description: Box Update group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: groups-groups.putgroupsid
      with:
        group_id: tools.group_id
        fields: tools.fields
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: box-remove-group
      description: Box Remove group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: groups-groups.deletegroupsid
      with:
        group_id: tools.group_id
      outputParameters:
      - type: object
        mapping: $.
    - name: box-list-group-collaborations
      description: Box List group collaborations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: groups-groups.getgroupsidcollaborations
      with:
        group_id: tools.group_id
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: box-list-members-group
      description: Box List members of group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: groups-groups.getgroupsidmemberships
      with:
        group_id: tools.group_id
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.