Terraform Provider for OpenAI

The OpenAI Terraform provider manages resources across two API audiences:

• The OpenAI Administration API for organization resources such as projects, users, groups, roles, service accounts, certificates, rate limits, and spend alerts.
• The project-scoped webhook API for webhook endpoints and event-type discovery.

Webhook management is beta. Its API and Terraform schema may change before general availability. Organization-level webhook management is not supported.

See docs/ for resource and data source documentation. For private MCP servers, see the Secure MCP tunnel guide and its Kubernetes deployment example.

Requirements

• Terraform CLI 1.0 or later
• One or both credentials below, according to the resources being managed

Admin API keys cannot be used for non-administration endpoints. The two credentials are not substitutes for one another.

Usage

Set the credentials required by your configuration:

export OPENAI_ADMIN_KEY="<your-admin-api-key>"
export OPENAI_API_KEY="<your-project-api-key>"

You may set only OPENAI_ADMIN_KEY for an administration-only configuration or only OPENAI_API_KEY for a webhook-only configuration. For example:

terraform {
  required_version = ">= 1.0"

  required_providers {
    openai = {
      source = "openai/openai"
    }
  }
}

provider "openai" {
  # The provider reads audience-specific credentials from the environment.
  # You can instead set admin_api_key and/or api_key explicitly.
}

resource "openai_project" "example" {
  name = "terraform-managed"
}

A webhook-only configuration does not require an Admin API key:

provider "openai" {}

resource "openai_webhook_endpoint" "events" {
  name        = "production-events"
  url         = "https://example.com/openai/webhooks"
  event_types = ["response.completed"]
}

Credentials are routed only to their configured audience. If the required credential is absent, the affected resource or data source reports the exact provider attribute and environment variable to set. The provider cannot infer a key's type from its value: putting a project key in admin_api_key, or an Admin key in api_key, sends it only to that field's API audience, where the OpenAI API rejects it. The provider never retries with the other credential.

The project provider attribute, or OPENAI_PROJECT_ID, sends the OpenAI-Project header for credentials that support project selection. It does not grant project access or change a credential's audience.

OPENAI_API_KEY is used only with the default OpenAI API origin. A custom base_url requires an explicit api_key to authorize sending the project credential there. For backward compatibility, OPENAI_ADMIN_KEY remains eligible for a configured custom origin; only trusted Terraform configuration should choose base_url when an Admin key is injected by the runtime.

Webhook signing secrets are returned only during creation and are stored as sensitive values in Terraform state. Protect the state backend. Import cannot recover the secret, and rotating it outside Terraform makes the stored value stale. Endpoint test delivery and signing-secret rotation are imperative API operations and are not managed by this provider.

See docs/index.md for provider configuration details and the full resource and data source documentation.

License

This project is licensed under the Apache License 2.0.