Axon Server REST API — Users

naftiko: 1.0.0-alpha2
info:
  label: Axon Server REST API — Users
  description: 'Axon Server REST API — Users. 3 operations. Lead operation: Axon Framework - List Users. Self-contained Naftiko
    capability covering one Axon Framework business surface.'
  tags:
  - Axon Framework
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AXON_FRAMEWORK_API_KEY: AXON_FRAMEWORK_API_KEY
capability:
  consumes:
  - type: http
    namespace: axon-server-users
    baseUri: ''
    description: Axon Server REST API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: Axon Framework - List Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Axon Framework - Create a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-username
      path: /users/{username}
      operations:
      - name: deleteuser
        method: DELETE
        description: Axon Framework - Delete a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: username
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: axon-server-users-rest
    port: 8080
    description: REST adapter for Axon Server REST API — Users. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for users.
      operations:
      - method: GET
        name: listusers
        description: Axon Framework - List Users
        call: axon-server-users.listusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Axon Framework - Create a User
        call: axon-server-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}
      name: users-username
      description: REST surface for users-username.
      operations:
      - method: DELETE
        name: deleteuser
        description: Axon Framework - Delete a User
        call: axon-server-users.deleteuser
        with:
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: axon-server-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Axon Server REST API — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: axon-framework-list-users
      description: Axon Framework - List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: axon-server-users.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: axon-framework-create-user
      description: Axon Framework - Create a User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: axon-server-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: axon-framework-delete-user
      description: Axon Framework - Delete a User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: axon-server-users.deleteuser
      with:
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.