OpenAI

Early Access: This integration is provided as an Open Authorization API (OAA) connector package. Contact our support team for more information.

Veza OpenAI OAA Connector

Veza Connector for OpenAI that discovers the Users that are members of an Organization and their assigned roles.

Properties

EntityPropertyDescription

Org

is_personal

True if Organization is a personal space

Org

organization_id

Organization ID

User

email

User's email

OpenAI Setup

  1. Sign-in to OpenAI Dashboard and Manage Account from the user drop down in the upper right

  2. Under settings note the Organization ID

  3. Generate a new API key or use an existing key

Veza Setup

  1. Generate an API token for your Veza user. For detailed instructions consult the Veza User Guide.

Running the Connector

There are multiple options to run the connector. Instructions are included for running from the command line and building a Docker container.

Command Line

  1. Install the requirements with Python 3.8+:

    pip3 install -r requirements.txt
  2. Export the required environmental variables. Variables not set can be passed via arguments at run time. All parameters can be passed using environment variables if desired. See table below for variable names and descriptions.

    export VEZA_API_KEY="Zdkemfds..."
    export ATLASSIAN_TOKEN="lsjflmmxvn..."
    ...
  3. Run the connector:

    ./veza_openai.py --openai-org org-67BO..... \
        --veza_url https://example.vezatrial.ai

Docker

A Dockerfile to build a container is included in the repository. Running the container will perform the OpenAI discovery and OAA push then exit. Schedule the container to run on a regular interval.

  1. Build the container.

    docker build . -t veza_openai
  2. To run the container, all required parameters must be provided as environment variables.

    docker run --rm \
     -e OPENAI_ORG_ID="org-67BO....." \
     -e OPENAI_API_KEY="abc123=" \
     -e VEZA_URL="https://customer.vezacloud.com" \
     -e VEZA_API_KEY="ZXlKaGJHY2lPaUpJVXpJM.....=" \
     veza_openai

Application Parameters / Environmental Variables

ParameterEnvironmental VariableRequiredNotes

N/A

VEZA_API_KEY

true

the API token which which to connect to the Veza instance

--veza_url

VEZA_URL

true

the url of the Veza instance to which the metadata will be uploaded

--openai-org

OPENAI_ORG_ID

true

Organization ID for OpenAI

N/A

OPENAI_API_KEY

true

API key for OpenAI

--save_json

N/A

false

save a copy of the metadata JSON uploaded to the Veza instance to this directory

--debug

N/A

false

enable verbose debug logging

Last updated