OAA Runner
oaa-runner is a framework for building and running data integrations that push identity and access data to Veza using the Open Authorization API (OAA).
It handles reading from sources (REST APIs, databases, CSV files, and more), applying field mappings and transforms, and uploading the result to Veza. You write a small module that fetches your data; the runner takes care of the rest.
How it works
Integrations are defined by a config.yaml file:
version: v2
veza_url: https://your-veza-instance.example.com
app:
name: my_app
application_type: my_app
sources:
users:
destination: LocalUser
source_type: csv
csv_filepath: ./data/users.csv
field_mapping:
UserID:
destination_field: unique_id
name:
destination_field: name
Fields can be transformed before they are uploaded, for example combining first/last name into a display name or normalizing an admin flag:
sources:
users:
destination: LocalUser
source_type: csv
csv_filepath: ./data/users.csv
field_mapping:
UserID:
destination_field: unique_id
name:
destination_field: name
transforms:
- name: jinja_render
options:
template: "{{row.firstName}} {{row.lastName}}"
IS_ADMIN:
destination_field: is_admin
custom_type: BOOLEAN
transforms:
- name: validate_boolean
Features:
- Source types: REST APIs, SQL/MySQL/Oracle databases, and CSV files
- Field mappings with transforms (Jinja templates, date conversion, lookups, joins, and more)
- Hooks for pre-run validation and transform-time customization
- Dry-run, no-push, and JSON-output modes for testing without writing to Veza
- A
bundlecommand to package an integration for deployment
Install
uv tool install oaa-runner
Quick start
oaa-run custom_app run --config-file=./config.yaml
Useful commands:
# Validate a config without running a full sync
oaa-run validate_config --config-file=./config.yaml
# List supported IdP provider types
oaa-run oaa_utils idp_provider_types
# List valid custom property types
oaa-run oaa_utils oaa_property_types
# Show the parsed config
oaa-run custom_app show_config --config-file=./config.yaml
Documentation
Full documentation is available at kajigga.github.io/oaa_generic.
Metadata
Release files for oaa-runner 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| oaa_runner-0.5.0.tar.gz | 274.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| oaa_runner-0.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 503.9 kB
Release files / oaa_runner-0.5.0.tar.gz
| Download URL | oaa_runner-0.5.0.tar.gz |
|---|---|
| Size | 274.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a9204a8720edf2cfbd8bcc15c0ce798ac22bcd470a247938d7435bc3effb171e
|
|
BLAKE2b-256 checksum How to use checksums |
92b394536b51d86a5708ceccc0e97142aae8a9bd3ecd368ec69f20f4cdc76e2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / oaa_runner-0.5.0-py3-none-any.whl
| Download URL | oaa_runner-0.5.0-py3-none-any.whl |
|---|---|
| Size | 229.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d8190ca18a8ce08a75c94485ce111a088e2c2e7388e6d7d9ca1c8aee0553c147
|
|
BLAKE2b-256 checksum How to use checksums |
925e597682ea80efd433f5e3de37cad9d162ec771163c03a04e7c982fe979a36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|