Evolveum Midpoint Python API Docs | dltHub

MidPoint's REST API allows access to various midPoint objects via HTTP endpoints, enabling CRUD operations on resources. The API documentation details endpoints for managing resources, including creation, retrieval, modification, and deletion. The REST API is a primary interface for MidPoint's functionality. The REST API base URL is http://<MIDPOINT_HOST>:<PORT>/midpoint/ws/rest and all requests use HTTP Basic authentication (username + password).

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Evolveum Midpoint data in under 10 minutes.

---

What data can I load from Evolveum Midpoint?

Here are some of the endpoints you can load from Evolveum Midpoint:

---

How do I authenticate with the Evolveum Midpoint API?

midPoint REST accepts HTTP Basic auth (Authorization: Basic base64(user:password)). Include Accept and Content-Type headers (e.g. Accept: application/json; Content-Type: application/json) for JSON payloads.

1. Get your credentials

1. Install or access your midPoint instance (usually admin account created on install). 2) Use an existing administrative or service account (e.g. 'administrator') or create a service user in the midPoint UI (Users → Add user). 3) Note the username and password for that account; those are used for Basic auth in API requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.evolveum_midpoint_source]
username = "your_midpoint_username"
password = "your_midpoint_password"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Evolveum Midpoint API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python evolveum_midpoint_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline evolveum_midpoint_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset evolveum_midpoint_data
The duckdb destination used duckdb:/evolveum_midpoint.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline evolveum_midpoint_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads users and resources from the Evolveum Midpoint API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def evolveum_midpoint_source(username=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "http://<MIDPOINT_HOST>:<PORT>/midpoint/ws/rest",
            "auth": {
                "type": "http_basic",
                "password": username,
            },
        },
        "resources": [
            {"name": "users", "endpoint": {"path": "midpoint/ws/rest/users", "data_selector": "object.object"}},
            {"name": "resources", "endpoint": {"path": "midpoint/ws/rest/resources", "data_selector": "object.object"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="evolveum_midpoint_pipeline",
        destination="duckdb",
        dataset_name="evolveum_midpoint_data",
    )
    load_info = pipeline.run(evolveum_midpoint_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("evolveum_midpoint_pipeline").dataset()
sessions_df = data.users.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM evolveum_midpoint_data.users LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("evolveum_midpoint_pipeline").dataset()
data.users.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Evolveum Midpoint data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack