8000 API-key access layer for programmatic and agent access · Issue #93 · NL-BioImaging/biomero · GitHub
[go: up one dir, main page]

Skip to content

API-key access layer for programmatic and agent access #93

Open

Description

@pmkrawczyk

Summary

Add an API-key access layer to BIOMERO so that external clients (scripts, workflow platforms, AI agents, an MCP server) can call BIOMERO safely without an interactive OMERO web session.

Motivation

Today runs are started from OMERO scripts (SLURM_Run_Workflow.py) or from OMERO.biomero's JSON endpoints (api/analyzer/workflows/<name>/jobs/), which rely on OMERO login sessions. Programmatic and agent-driven use (listing workflows, submitting and chaining runs on OMERO datasets, polling status, fetching results with provenance) needs a non-interactive, revocable and auditable credential. This is also a prerequisite for the MCP server (#68) and for a client library.

Proposed scope

  • Keys: per-user API keys, plus optional service keys for trusted integrations; created, listed and revoked by the user (and by admins for service keys); shown once, stored hashed.
  • Identity and permissions: a key acts as its OMERO user (or a declared service identity), respecting OMERO group permissions and BIOMERO's workflow restrictions (Restrict certain workflows to certain users/groups #75); never more than the user can do in the web UI.
  • Scopes: at least workflows:read, runs:submit, runs:read, runs:cancel, results:read; optionally workflows:register (admins).
  • Expiry and rotation: an optional expiry date; keys inactive for a long period can be disabled.
  • Audit: every call logged with key ID, user, action, target (workflow, dataset, job) and result; visible to admins.
  • Transport: HTTPS only; key in an Authorization: Bearer header; rate limits per key.
  • Endpoints covered (first slice): list and describe workflows; submit a run (workflow, version, OMERO dataset/images, parameters); job status and logs; cancel; fetch results and their provenance (inputs, workflow version, parameters, outputs).

Out of scope (separate issues)

The MCP server itself (#68), a Python client library, workflow registration via the API, and chaining.

Related

#68 (MCP server), #75 (restrict workflows to groups), #76 (cancel jobs), #77 (SSH key per user), OMERO.biomero#58 (rerun with reviewed parameters).

Activity

  1. self-assigned this
    on Nov 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    0