OAA Runner documentation

We already have the Python SDK which simplifies building the payloads required for transport data to Veza’s Open Authorization API (OAA). Many connectors have been built using a simple script and this SDK. See examples at the community repository.

While these examples are fairly simple to understand and deploy as standalone python scripts, they remain separate scripts that do not really follow a standard best-practice.

We wanted a predictable way to build these connectors. Anyone who supports or builds one should know where to look to find the various pieces of a connector. They should know what to expect. For example, you should know to expect to find a config.yaml, a modules folder, and likely a .env file.

In fact, we wrote a utility function to generate a connector project.

Quick Start with uv

The fastest way to get started is with uv, a modern Python tool runner:

  1. Check if uv is installed: uv --version

  2. If not installed: See How to Install uv

  3. Run an integration: uv tool run --from oaa-runner oaa app run --config=config.yaml --save-json

!!! note “Deprecated Command” The older oaa custom_app command is deprecated. Use oaa app instead (functionally identical).

Generate a New Connector Project

We wrote a utility function to generate a connector project:

oaa app gen_oaa --folder-location path/to/parent/folder new_app

Running the command above would create a folder structure like this:

├── config.yaml
└── modules
    ├── workiva_mocks.py
    ├── workiva_hooks.py
    └── workiva.p

What Problem Does this solve?

Contents