Skip to main content

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 bundle command 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.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oaa-runner 0.4.0
File Size Uploaded
oaa_runner-0.4.0.tar.gz 267.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for oaa-runner 0.4.0
File Interpreter ABI Platform
oaa_runner-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 491.9 kB

Release files / oaa_runner-0.4.0.tar.gz

Download URL oaa_runner-0.4.0.tar.gz
Size 267.4 kB
Tags Source
SHA-256 checksum
How to use checksums
40d1950254dbf4e3dacb885390371fab3fa5f3179dbb3d53b5e1c946d97db878
BLAKE2b-256 checksum
How to use checksums
a617680f176fa2dd3b4c84bb54470582ccd2ecbdc069ab9c3b48453ac70b8887
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.16 {"installer":{"name":"uv","version":"0.12.16","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.4.0-py3-none-any.whl

Download URL oaa_runner-0.4.0-py3-none-any.whl
Size 224.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c6e9209149f5412d11dcfce62b87d4d5e24ab85ce5ddae91a06d056bd08f3f95
BLAKE2b-256 checksum
How to use checksums
4ce730c4a81d64bfd7f18920e18bb4fa4218b6138d1bce84127a81d817ddee6b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.16 {"installer":{"name":"uv","version":"0.12.16","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 history Release notifications | RSS feed

0.5.1

2 release files

0.5.0

2 release files

This release

0.4.0 This release

2 release files

0.3.0

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.0

2 release files

0.1.70

2 release files

0.1.69

2 release files

0.1.68

2 release files

0.1.67

2 release files

0.1.66

2 release files

0.1.63

2 release files

0.1.62

2 release files

0.1.61

2 release files

0.1.59

2 release files

0.1.58

2 release files

0.1.57

2 release files

0.1.51

2 release files

0.1.35

2 release files

0.1.30

2 release files

0.1.29

2 release files

0.1.26

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page