Passbolt API — Groups

naftiko: 1.0.0-alpha2
info:
  label: Passbolt API — Groups
  description: 'Passbolt API — Groups. 7 operations. Lead operation: Get multiple groups.. Self-contained Naftiko capability
    covering one Passbolt business surface.'
  tags:
  - Passbolt
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PASSBOLT_API_KEY: PASSBOLT_API_KEY
capability:
  consumes:
  - type: http
    namespace: passbolt-groups
    baseUri: https://passbolt.local
    description: Passbolt API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: groups.json
      path: /groups.json
      operations:
      - name: indexgroups
        method: GET
        description: Get multiple groups.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addgroup
        method: POST
        description: Create a group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: groups-groupId}.json
      path: /groups/{groupId}.json
      operations:
      - name: viewgroup
        method: GET
        description: Get a group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategroup
        method: PUT
        description: Update a group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletegroup
        method: DELETE
        description: Delete a group.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupId-dry-run.json
      path: /groups/{groupId}/dry-run.json
      operations:
      - name: dryrunupdategroup
        method: PUT
        description: Dry run a group update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: dryrundeletegroup
        method: DELETE
        description: Dry run a group deletion.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.PASSBOLT_API_KEY}}'
  exposes:
  - type: rest
    namespace: passbolt-groups-rest
    port: 8080
    description: REST adapter for Passbolt API — Groups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/groups-json
      name: groups-json
      description: REST surface for groups.json.
      operations:
      - method: GET
        name: indexgroups
        description: Get multiple groups.
        call: passbolt-groups.indexgroups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addgroup
        description: Create a group.
        call: passbolt-groups.addgroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/groupid-json
      name: groups-groupid-json
      description: REST surface for groups-groupId}.json.
      operations:
      - method: GET
        name: viewgroup
        description: Get a group.
        call: passbolt-groups.viewgroup
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updategroup
        description: Update a group.
        call: passbolt-groups.updategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroup
        description: Delete a group.
        call: passbolt-groups.deletegroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{groupid}/dry-run-json
      name: groups-groupid-dry-run-json
      description: REST surface for groups-groupId-dry-run.json.
      operations:
      - method: PUT
        name: dryrunupdategroup
        description: Dry run a group update.
        call: passbolt-groups.dryrunupdategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: dryrundeletegroup
        description: Dry run a group deletion.
        call: passbolt-groups.dryrundeletegroup
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: passbolt-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Passbolt API — Groups. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-multiple-groups
      description: Get multiple groups.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: passbolt-groups.indexgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: create-group
      description: Create a group.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: passbolt-groups.addgroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-group
      description: Get a group.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: passbolt-groups.viewgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: update-group
      description: Update a group.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: passbolt-groups.updategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-group
      description: Delete a group.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: passbolt-groups.deletegroup
      outputParameters:
      - type: object
        mapping: $.
    - name: dry-run-group-update
      description: Dry run a group update.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: passbolt-groups.dryrunupdategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dry-run-group-deletion
      description: Dry run a group deletion.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: passbolt-groups.dryrundeletegroup
      outputParameters:
      - type: object
        mapping: $.