tap-adobe-umapi

tap-adobe-umapi is a Singer tap for the Adobe User Management API.

Built with the Meltano Tap SDK for Singer Taps and the Adobe User Management API Reference

Configuration

Accepted Config Options

Capabilities

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening

Settings

Setting	Required	Default	Description
client_id	True	None	The Client ID for the service account (JWT).
client_secret	True	None	The Client Secret for the service account (JWT).
technical_account_id	True	None	The Technical Account ID for the service account (JWT).
private_key	True	None	The Private Key for the service account (JWT).
organization_id	True	None	The unique identifier for an organization.
auth_expiration	False	300	Expiraton in seconds for JWT exchange (Max: 86400, Recomended as small as possible).
user_agent	False	None	User agent to present to the API.
api_url	False	None	Override the Adobe User Management API base URL.
auth_url	False	None	Override the Adobe authentication API base URL.

A full list of supported settings and capabilities is available by running: tap-adobe-umapi --about

Configure using environment variables

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

Source Authentication and Authorization

Required auth configuration can be found here.

Executing the Tap Directly

tap-adobe-umapi --version
tap-adobe-umapi --help
tap-adobe-umapi --config CONFIG --discover > ./catalog.json

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_adobe_umapi/tests subfolder and then run:

poetry run pytest

You can also test the tap_adobe_umapi CLI interface directly using poetry run:

poetry run tap-adobe-umapi --help

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-adobe-umapi
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-adobe-umapi --version
# OR run a test `elt` pipeline:
meltano elt tap-adobe-umapi target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.