BetterCloud Platform API — Groups

naftiko: 1.0.0-alpha2
info:
  label: BetterCloud Platform API — Groups
  description: 'BetterCloud Platform API — Groups. 6 operations. Lead operation: BetterCloud List Groups. Self-contained Naftiko
    capability covering one Bettercloud business surface.'
  tags:
  - Bettercloud
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BETTERCLOUD_API_KEY: BETTERCLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-groups
    baseUri: https://api.bettercloud.com/v1
    description: BetterCloud Platform API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: groups
      path: /groups
      operations:
      - name: listgroups
        method: GET
        description: BetterCloud List Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: Page number.
        - name: per_page
          in: query
          type: integer
          description: Results per page.
      - name: creategroup
        method: POST
        description: BetterCloud Create Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-id
      path: /groups/{id}
      operations:
      - name: getgroup
        method: GET
        description: BetterCloud Get Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the group.
          required: true
      - name: deletegroup
        method: DELETE
        description: BetterCloud Delete Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the group.
          required: true
    - name: groups-id-members
      path: /groups/{id}/members
      operations:
      - name: listgroupmembers
        method: GET
        description: BetterCloud List Group Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the group.
          required: true
      - name: addgroupmember
        method: POST
        description: BetterCloud Add Group Member
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the group.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.BETTERCLOUD_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: platform-groups-rest
    port: 8080
    description: REST adapter for BetterCloud Platform 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: listgroups
        description: BetterCloud List Groups
        call: platform-groups.listgroups
        with:
          page: rest.page
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategroup
        description: BetterCloud Create Group
        call: platform-groups.creategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{id}
      name: groups-id
      description: REST surface for groups-id.
      operations:
      - method: GET
        name: getgroup
        description: BetterCloud Get Group
        call: platform-groups.getgroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroup
        description: BetterCloud Delete Group
        call: platform-groups.deletegroup
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{id}/members
      name: groups-id-members
      description: REST surface for groups-id-members.
      operations:
      - method: GET
        name: listgroupmembers
        description: BetterCloud List Group Members
        call: platform-groups.listgroupmembers
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addgroupmember
        description: BetterCloud Add Group Member
        call: platform-groups.addgroupmember
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for BetterCloud Platform API — Groups. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: bettercloud-list-groups
      description: BetterCloud List Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-groups.listgroups
      with:
        page: tools.page
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-create-group
      description: BetterCloud Create Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-groups.creategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-get-group
      description: BetterCloud Get Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-groups.getgroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-delete-group
      description: BetterCloud Delete Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-groups.deletegroup
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-list-group-members
      description: BetterCloud List Group Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-groups.listgroupmembers
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: bettercloud-add-group-member
      description: BetterCloud Add Group Member
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-groups.addgroupmember
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.