Basiq API — Users

naftiko: 1.0.0-alpha2
info:
  label: Basiq API — Users
  description: 'Basiq API — Users. 3 operations. Lead operation: Create User. Self-contained Naftiko capability covering one
    Basiq business surface.'
  tags:
  - Basiq
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BASIQ_API_KEY: BASIQ_API_KEY
capability:
  consumes:
  - type: http
    namespace: basiq-users
    baseUri: https://au-api.basiq.io
    description: Basiq API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: createuser
        method: POST
        description: Create User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-userId
      path: /users/{userId}
      operations:
      - name: getuser
        method: GET
        description: Get User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteuser
        method: DELETE
        description: Delete User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.BASIQ_API_KEY}}'
  exposes:
  - type: rest
    namespace: basiq-users-rest
    port: 8080
    description: REST adapter for Basiq 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: POST
        name: createuser
        description: Create User
        call: basiq-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}
      name: users-userid
      description: REST surface for users-userId.
      operations:
      - method: GET
        name: getuser
        description: Get User
        call: basiq-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Delete User
        call: basiq-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: basiq-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Basiq API — Users. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: create-user
      description: Create User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: basiq-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user
      description: Get User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: basiq-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: basiq-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.