Seismic User Management API — Groups

naftiko: 1.0.0-alpha2
info:
  label: Seismic User Management API — Groups
  description: 'Seismic User Management API — Groups. 10 operations. Lead operation: List Groups. Self-contained Naftiko capability
    covering one Seismic business surface.'
  tags:
  - Seismic
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SEISMIC_API_KEY: SEISMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: user-management-groups
    baseUri: https://api.seismic.com/integration/v2
    description: Seismic User Management API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: groups
      path: /groups
      operations:
      - name: listgroups
        method: GET
        description: List Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: Search query to filter groups by name.
        - name: parentId
          in: query
          type: string
          description: Filter by parent group ID for hierarchical groups.
        - name: offset
          in: query
          type: integer
          description: Number of items to skip for pagination.
        - name: limit
          in: query
          type: integer
          description: Maximum number of items to return.
      - name: creategroup
        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: true
    - name: groups-groupId
      path: /groups/{groupId}
      operations:
      - name: getgroup
        method: GET
        description: Get a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategroup
        method: PATCH
        description: Update a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletegroup
        method: DELETE
        description: Delete a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupId-members
      path: /groups/{groupId}/members
      operations:
      - name: listgroupmembers
        method: GET
        description: List Group Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: Number of items to skip for pagination.
        - name: limit
          in: query
          type: integer
          description: Maximum number of items to return.
      - name: addgroupmember
        method: POST
        description: Add a Member to a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-groupId-members-userId
      path: /groups/{groupId}/members/{userId}
      operations:
      - name: removegroupmember
        method: DELETE
        description: Remove a Member from a Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-userId-groups
      path: /users/{userId}/groups
      operations:
      - name: getusergroups
        method: GET
        description: Get User Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: setusergroups
        method: PUT
        description: Set User Group Memberships
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SEISMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: user-management-groups-rest
    port: 8080
    description: REST adapter for Seismic User Management 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: List Groups
        call: user-management-groups.listgroups
        with:
          query: rest.query
          parentId: rest.parentId
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategroup
        description: Create a Group
        call: user-management-groups.creategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{groupid}
      name: groups-groupid
      description: REST surface for groups-groupId.
      operations:
      - method: GET
        name: getgroup
        description: Get a Group
        call: user-management-groups.getgroup
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updategroup
        description: Update a Group
        call: user-management-groups.updategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroup
        description: Delete a Group
        call: user-management-groups.deletegroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{groupid}/members
      name: groups-groupid-members
      description: REST surface for groups-groupId-members.
      operations:
      - method: GET
        name: listgroupmembers
        description: List Group Members
        call: user-management-groups.listgroupmembers
        with:
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addgroupmember
        description: Add a Member to a Group
        call: user-management-groups.addgroupmember
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{groupid}/members/{userid}
      name: groups-groupid-members-userid
      description: REST surface for groups-groupId-members-userId.
      operations:
      - method: DELETE
        name: removegroupmember
        description: Remove a Member from a Group
        call: user-management-groups.removegroupmember
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/groups
      name: users-userid-groups
      description: REST surface for users-userId-groups.
      operations:
      - method: GET
        name: getusergroups
        description: Get User Groups
        call: user-management-groups.getusergroups
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: setusergroups
        description: Set User Group Memberships
        call: user-management-groups.setusergroups
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: user-management-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Seismic User Management API — Groups. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-groups
      description: List Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: user-management-groups.listgroups
      with:
        query: tools.query
        parentId: tools.parentId
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-group
      description: Create a Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: user-management-groups.creategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-group
      description: Get a Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: user-management-groups.getgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: update-group
      description: Update a Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: user-management-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: user-management-groups.deletegroup
      outputParameters:
      - type: object
        mapping: $.
    - name: list-group-members
      description: List Group Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: user-management-groups.listgroupmembers
      with:
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: add-member-group
      description: Add a Member to a Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: user-management-groups.addgroupmember
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-member-group
      description: Remove a Member from a Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: user-management-groups.removegroupmember
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-groups
      description: Get User Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: user-management-groups.getusergroups
      outputParameters:
      - type: object
        mapping: $.
    - name: set-user-group-memberships
      description: Set User Group Memberships
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: user-management-groups.setusergroups
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.