CyberArk Identity API Python API Docs | dltHub

CyberArk Identity API is a platform for managing identities, authentication, and access with adaptive MFA and SSO. The REST API base URL is https://<identity-tenant-id>.id.cyberark.cloud and All requests require a Bearer token obtained via OAuth2 client‑credentials flow..

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 CyberArk Identity API data in under 10 minutes.

---

What data can I load from CyberArk Identity API?

Here are some of the endpoints you can load from CyberArk Identity API:

---

How do I authenticate with the CyberArk Identity API API?

Authentication uses OAuth2 client‑credentials flow; include the returned access token in the Authorization: Bearer <token> header on every request.

1. Get your credentials

1. Log into the CyberArk Identity portal.
2. Navigate to API Tokens under the tenant settings.
3. Click Create New Token, provide a name, and note the generated Client ID and Client Secret.
4. Use the client credentials with the token endpoint (POST /oauth2/platformtoken) to obtain an access token.

2. Add them to .dlt/secrets.toml

Copy
[sources.cyberark_identity_api_source]
client_id = "your_client_id_here"
client_secret = "your_client_secret_here"

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 CyberArk Identity API 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 cyberark_identity_api_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline cyberark_identity_api_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 applications from the CyberArk Identity API 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 cyberark_identity_api_source(client_id=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<identity-tenant-id>.id.cyberark.cloud",
            "auth": {
                "type": "bearer",
                "token": client_id,
            },
        },
        "resources": [
            {"name": "users", "endpoint": {"path": "Users", "data_selector": "users"}},
            {"name": "applications", "endpoint": {"path": "Applications", "data_selector": "applications"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="cyberark_identity_api_pipeline",
        destination="duckdb",
        dataset_name="cyberark_identity_api_data",
    )
    load_info = pipeline.run(cyberark_identity_api_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("cyberark_identity_api_pipeline").dataset()
sessions_df = data.users.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM cyberark_identity_api_data.users LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("cyberark_identity_api_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 CyberArk Identity API 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.

---

Troubleshooting

Authentication Errors

• 401 Unauthorized – Occurs when the Bearer token is missing, expired, or invalid. Obtain a new token via the /oauth2/platformtoken endpoint.

Rate Limiting

• 429 Too Many Requests – The API enforces request limits per tenant. Implement exponential backoff and respect the Retry-After header.

Pagination

• Many list endpoints return paginated results. Use the page and pageSize query parameters and follow the nextPage link in the response metadata.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

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