JupyterHub REST API — Users

naftiko: 1.0.0-alpha2
info:
  label: JupyterHub REST API — Users
  description: 'JupyterHub REST API — Users. 9 operations. Lead operation: List users. Self-contained Naftiko capability covering
    one Jupyter Hub business surface.'
  tags:
  - Jupyter Hub
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JUPYTER_HUB_API_KEY: JUPYTER_HUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: jupyter-hub-users
    baseUri: https://your-jupyterhub-domain.com/hub/api
    description: JupyterHub REST API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: List users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: state
          in: query
          type: string
        - name: offset
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
      - name: createusers
        method: POST
        description: Create multiple users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-name
      path: /users/{name}
      operations:
      - name: getuser
        method: GET
        description: Get a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Create a single user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteuser
        method: DELETE
        description: Delete a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-name-server
      path: /users/{name}/server
      operations:
      - name: startuserserver
        method: POST
        description: Start a user's default server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: stopuserserver
        method: DELETE
        description: Stop a user's default server
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-name-servers-server_name
      path: /users/{name}/servers/{server_name}
      operations:
      - name: startnamedserver
        method: POST
        description: Start a named server for a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: stopnamedserver
        method: DELETE
        description: Stop a named server for a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.JUPYTER_HUB_API_KEY}}'
  exposes:
  - type: rest
    namespace: jupyter-hub-users-rest
    port: 8080
    description: REST adapter for JupyterHub 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: List users
        call: jupyter-hub-users.listusers
        with:
          state: rest.state
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createusers
        description: Create multiple users
        call: jupyter-hub-users.createusers
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{name}
      name: users-name
      description: REST surface for users-name.
      operations:
      - method: GET
        name: getuser
        description: Get a user
        call: jupyter-hub-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Create a single user
        call: jupyter-hub-users.createuser
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Delete a user
        call: jupyter-hub-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{name}/server
      name: users-name-server
      description: REST surface for users-name-server.
      operations:
      - method: POST
        name: startuserserver
        description: Start a user's default server
        call: jupyter-hub-users.startuserserver
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: stopuserserver
        description: Stop a user's default server
        call: jupyter-hub-users.stopuserserver
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{name}/servers/{server-name}
      name: users-name-servers-server-name
      description: REST surface for users-name-servers-server_name.
      operations:
      - method: POST
        name: startnamedserver
        description: Start a named server for a user
        call: jupyter-hub-users.startnamedserver
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: stopnamedserver
        description: Stop a named server for a user
        call: jupyter-hub-users.stopnamedserver
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jupyter-hub-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for JupyterHub REST API — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-users
      description: List users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jupyter-hub-users.listusers
      with:
        state: tools.state
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-multiple-users
      description: Create multiple users
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jupyter-hub-users.createusers
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user
      description: Get a user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jupyter-hub-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: create-single-user
      description: Create a single user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jupyter-hub-users.createuser
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete a user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jupyter-hub-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.
    - name: start-user-s-default-server
      description: Start a user's default server
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jupyter-hub-users.startuserserver
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-user-s-default-server
      description: Stop a user's default server
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jupyter-hub-users.stopuserserver
      outputParameters:
      - type: object
        mapping: $.
    - name: start-named-server-user
      description: Start a named server for a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jupyter-hub-users.startnamedserver
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-named-server-user
      description: Stop a named server for a user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jupyter-hub-users.stopnamedserver
      outputParameters:
      - type: object
        mapping: $.