1. Registry
  2. Packages
  3. Harness Provider
  4. API Docs
  5. platform
  6. ConnectorOpenaiModel
Viewing docs for Harness v0.17.6
published on Saturday, Oct 31, 2026 by Pulumi
harness logo
Viewing docs for Harness v0.17.6
published on Saturday, Oct 31, 2026 by Pulumi

    Resource for creating an OpenAI Model connector.

    Example Usage

    Token Authentication

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const token = new harness.platform.ConnectorOpenaiModel("token", {
        auth: {
            token: {
                tokenRef: "account.openai_api_key",
            },
            authType: "Token",
        },
        identifier: "example_openai_token",
        name: "example-openai-token",
        description: "OpenAI connector with Token auth",
        url: "https://api.openai.com",
        model: "gpt-4o",
        executeOnDelegate: true,
        ignoreTestConnection: false,
    });
    
    import pulumi
    import pulumi_harness as harness
    
    token = harness.platform.ConnectorOpenaiModel("token",
        auth={
            "token": {
                "token_ref": "account.openai_api_key",
            },
            "auth_type": "Token",
        },
        identifier="example_openai_token",
        name="example-openai-token",
        description="OpenAI connector with Token auth",
        url="https://api.openai.com",
        model="gpt-4o",
        execute_on_delegate=True,
        ignore_test_connection=False)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewConnectorOpenaiModel(ctx, "token", &platform.ConnectorOpenaiModelArgs{
    			Auth: &platform.ConnectorOpenaiModelAuthArgs{
    				Token: &platform.ConnectorOpenaiModelAuthTokenArgs{
    					TokenRef: pulumi.String("account.openai_api_key"),
    				},
    				AuthType: pulumi.String("Token"),
    			},
    			Identifier:           pulumi.String("example_openai_token"),
    			Name:                 pulumi.String("example-openai-token"),
    			Description:          pulumi.String("OpenAI connector with Token auth"),
    			Url:                  pulumi.String("https://api.openai.com"),
    			Model:                pulumi.String("gpt-4o"),
    			ExecuteOnDelegate:    pulumi.Bool(true),
    			IgnoreTestConnection: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var token = new Harness.Platform.ConnectorOpenaiModel("token", new()
        {
            Auth = new Harness.Platform.Inputs.ConnectorOpenaiModelAuthArgs
            {
                Token = new Harness.Platform.Inputs.ConnectorOpenaiModelAuthTokenArgs
                {
                    TokenRef = "account.openai_api_key",
                },
                AuthType = "Token",
            },
            Identifier = "example_openai_token",
            Name = "example-openai-token",
            Description = "OpenAI connector with Token auth",
            Url = "https://api.openai.com",
            Model = "gpt-4o",
            ExecuteOnDelegate = true,
            IgnoreTestConnection = false,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.ConnectorOpenaiModel;
    import com.pulumi.harness.platform.ConnectorOpenaiModelArgs;
    import com.pulumi.harness.platform.inputs.ConnectorOpenaiModelAuthArgs;
    import com.pulumi.harness.platform.inputs.ConnectorOpenaiModelAuthTokenArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var token = new ConnectorOpenaiModel("token", ConnectorOpenaiModelArgs.builder()
                .auth(ConnectorOpenaiModelAuthArgs.builder()
                    .token(ConnectorOpenaiModelAuthTokenArgs.builder()
                        .tokenRef("account.openai_api_key")
                        .build())
                    .authType("Token")
                    .build())
                .identifier("example_openai_token")
                .name("example-openai-token")
                .description("OpenAI connector with Token auth")
                .url("https://api.openai.com")
                .model("gpt-4o")
                .executeOnDelegate(true)
                .ignoreTestConnection(false)
                .build());
    
        }
    }
    
    resources:
      token:
        type: harness:platform:ConnectorOpenaiModel
        properties:
          auth:
            token:
              tokenRef: account.openai_api_key
            authType: Token
          identifier: example_openai_token
          name: example-openai-token
          description: OpenAI connector with Token auth
          url: https://api.openai.com
          model: gpt-4o
          executeOnDelegate: true
          ignoreTestConnection: false
    
    terraform {
      required_providers {
        harness = {
          source = "pulumi/harness"
        }
      }
    }
    
    resource "harness_platform_connector_openai_model" "token" {
      lifecycle {
        create_before_destroy = true
      }
      auth {
        token {
          token_ref = "account.openai_api_key"
        }
        auth_type = "Token"
      }
      identifier             = "example_openai_token"
      name                   = "example-openai-token"
      description            = "OpenAI connector with Token auth"
      url                    = "https://api.openai.com"
      model                  = "gpt-4o"
      execute_on_delegate    = true
      ignore_test_connection = false
    }
    

    Vertex AI Authentication

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const vertex = new harness.platform.ConnectorOpenaiModel("vertex", {
        auth: {
            vertex: {
                serviceAccountKeyRef: "account.gcp_sa_key",
                projectId: "my-gcp-project",
                region: "us-central1",
            },
            authType: "Vertex",
        },
        identifier: "example_openai_vertex",
        name: "example-openai-vertex",
        description: "OpenAI connector with Vertex AI auth",
        url: "https://api.openai.com",
        model: "gpt-4o",
        executeOnDelegate: true,
        ignoreTestConnection: true,
        delegateSelectors: ["mydelegate"],
    });
    
    import pulumi
    import pulumi_harness as harness
    
    vertex = harness.platform.ConnectorOpenaiModel("vertex",
        auth={
            "vertex": {
                "service_account_key_ref": "account.gcp_sa_key",
                "project_id": "my-gcp-project",
                "region": "us-central1",
            },
            "auth_type": "Vertex",
        },
        identifier="example_openai_vertex",
        name="example-openai-vertex",
        description="OpenAI connector with Vertex AI auth",
        url="https://api.openai.com",
        model="gpt-4o",
        execute_on_delegate=True,
        ignore_test_connection=True,
        delegate_selectors=["mydelegate"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewConnectorOpenaiModel(ctx, "vertex", &platform.ConnectorOpenaiModelArgs{
    			Auth: &platform.ConnectorOpenaiModelAuthArgs{
    				Vertex: &platform.ConnectorOpenaiModelAuthVertexArgs{
    					ServiceAccountKeyRef: pulumi.String("account.gcp_sa_key"),
    					ProjectId:            pulumi.String("my-gcp-project"),
    					Region:               pulumi.String("us-central1"),
    				},
    				AuthType: pulumi.String("Vertex"),
    			},
    			Identifier:           pulumi.String("example_openai_vertex"),
    			Name:                 pulumi.String("example-openai-vertex"),
    			Description:          pulumi.String("OpenAI connector with Vertex AI auth"),
    			Url:                  pulumi.String("https://api.openai.com"),
    			Model:                pulumi.String("gpt-4o"),
    			ExecuteOnDelegate:    pulumi.Bool(true),
    			IgnoreTestConnection: pulumi.Bool(true),
    			DelegateSelectors: pulumi.StringArray{
    				pulumi.String("mydelegate"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var vertex = new Harness.Platform.ConnectorOpenaiModel("vertex", new()
        {
            Auth = new Harness.Platform.Inputs.ConnectorOpenaiModelAuthArgs
            {
                Vertex = new Harness.Platform.Inputs.ConnectorOpenaiModelAuthVertexArgs
                {
                    ServiceAccountKeyRef = "account.gcp_sa_key",
                    ProjectId = "my-gcp-project",
                    Region = "us-central1",
                },
                AuthType = "Vertex",
            },
            Identifier = "example_openai_vertex",
            Name = "example-openai-vertex",
            Description = "OpenAI connector with Vertex AI auth",
            Url = "https://api.openai.com",
            Model = "gpt-4o",
            ExecuteOnDelegate = true,
            IgnoreTestConnection = true,
            DelegateSelectors = new[]
            {
                "mydelegate",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.ConnectorOpenaiModel;
    import com.pulumi.harness.platform.ConnectorOpenaiModelArgs;
    import com.pulumi.harness.platform.inputs.ConnectorOpenaiModelAuthArgs;
    import com.pulumi.harness.platform.inputs.ConnectorOpenaiModelAuthVertexArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var vertex = new ConnectorOpenaiModel("vertex", ConnectorOpenaiModelArgs.builder()
                .auth(ConnectorOpenaiModelAuthArgs.builder()
                    .vertex(ConnectorOpenaiModelAuthVertexArgs.builder()
                        .serviceAccountKeyRef("account.gcp_sa_key")
                        .projectId("my-gcp-project")
                        .region("us-central1")
                        .build())
                    .authType("Vertex")
                    .build())
                .identifier("example_openai_vertex")
                .name("example-openai-vertex")
                .description("OpenAI connector with Vertex AI auth")
                .url("https://api.openai.com")
                .model("gpt-4o")
                .executeOnDelegate(true)
                .ignoreTestConnection(true)
                .delegateSelectors("mydelegate")
                .build());
    
        }
    }
    
    resources:
      vertex:
        type: harness:platform:ConnectorOpenaiModel
        properties:
          auth:
            vertex:
              serviceAccountKeyRef: account.gcp_sa_key
              projectId: my-gcp-project
              region: us-central1
            authType: Vertex
          identifier: example_openai_vertex
          name: example-openai-vertex
          description: OpenAI connector with Vertex AI auth
          url: https://api.openai.com
          model: gpt-4o
          executeOnDelegate: true
          ignoreTestConnection: true
          delegateSelectors:
            - mydelegate
    
    terraform {
      required_providers {
        harness = {
          source = "pulumi/harness"
        }
      }
    }
    
    resource "harness_platform_connector_openai_model" "vertex" {
      lifecycle {
        create_before_destroy = true
      }
      auth {
        vertex {
          service_account_key_ref = "account.gcp_sa_key"
          project_id              = "my-gcp-project"
          region                  = "us-central1"
        }
        auth_type = "Vertex"
      }
      identifier             = "example_openai_vertex"
      name                   = "example-openai-vertex"
      description            = "OpenAI connector with Vertex AI auth"
      url                    = "https://api.openai.com"
      model                  = "gpt-4o"
      execute_on_delegate    = true
      ignore_test_connection = true
      delegate_selectors     = ["mydelegate"]
    }
    

    Create ConnectorOpenaiModel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConnectorOpenaiModel(name: string, args: ConnectorOpenaiModelArgs, opts?: CustomResourceOptions);
    @overload
    def ConnectorOpenaiModel(resource_name: str,
                             args: ConnectorOpenaiModelArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConnectorOpenaiModel(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             auth: Optional[ConnectorOpenaiModelAuthArgs] = None,
                             identifier: Optional[str] = None,
                             model: Optional[str] = None,
                             url: Optional[str] = None,
                             delegate_selectors: Optional[Sequence[str]] = None,
                             description: Optional[str] = None,
                             execute_on_delegate: Optional[bool] = None,
                             ignore_test_connection: Optional[bool] = None,
                             name: Optional[str] = None,
                             org_id: Optional[str] = None,
                             project_id: Optional[str] = None,
                             tags: Optional[Sequence[str]] = None)
    func NewConnectorOpenaiModel(ctx *Context, name string, args ConnectorOpenaiModelArgs, opts ...ResourceOption) (*ConnectorOpenaiModel, error)
    public ConnectorOpenaiModel(string name, ConnectorOpenaiModelArgs args, CustomResourceOptions? opts = null)
    public ConnectorOpenaiModel(String name, ConnectorOpenaiModelArgs args)
    public ConnectorOpenaiModel(String name, ConnectorOpenaiModelArgs args, CustomResourceOptions options)
    
    type: harness:platform:ConnectorOpenaiModel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "harness_platform_connector_openai_model" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ConnectorOpenaiModelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectorOpenaiModelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectorOpenaiModelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorOpenaiModelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorOpenaiModelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var connectorOpenaiModelResource = new Harness.Platform.ConnectorOpenaiModel("connectorOpenaiModelResource", new()
    {
        Auth = new Harness.Platform.Inputs.ConnectorOpenaiModelAuthArgs
        {
            AuthType = "string",
            Token = new Harness.Platform.Inputs.ConnectorOpenaiModelAuthTokenArgs
            {
                TokenRef = "string",
            },
            Vertex = new Harness.Platform.Inputs.ConnectorOpenaiModelAuthVertexArgs
            {
                ProjectId = "string",
                Region = "string",
                ServiceAccountKeyRef = "string",
            },
        },
        Identifier = "string",
        Model = "string",
        Url = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
        Description = "string",
        ExecuteOnDelegate = false,
        IgnoreTestConnection = false,
        Name = "string",
        OrgId = "string",
        ProjectId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewConnectorOpenaiModel(ctx, "connectorOpenaiModelResource", &platform.ConnectorOpenaiModelArgs{
    	Auth: &platform.ConnectorOpenaiModelAuthArgs{
    		AuthType: pulumi.String("string"),
    		Token: &platform.ConnectorOpenaiModelAuthTokenArgs{
    			TokenRef: pulumi.String("string"),
    		},
    		Vertex: &platform.ConnectorOpenaiModelAuthVertexArgs{
    			ProjectId:            pulumi.String("string"),
    			Region:               pulumi.String("string"),
    			ServiceAccountKeyRef: pulumi.String("string"),
    		},
    	},
    	Identifier: pulumi.String("string"),
    	Model:      pulumi.String("string"),
    	Url:        pulumi.String("string"),
    	DelegateSelectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description:          pulumi.String("string"),
    	ExecuteOnDelegate:    pulumi.Bool(false),
    	IgnoreTestConnection: pulumi.Bool(false),
    	Name:                 pulumi.String("string"),
    	OrgId:                pulumi.String("string"),
    	ProjectId:            pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "harness_platform_connector_openai_model" "connectorOpenaiModelResource" {
      lifecycle {
        create_before_destroy = true
      }
      auth = {
        auth_type = "string"
        token = {
          token_ref = "string"
        }
        vertex = {
          project_id              = "string"
          region                  = "string"
          service_account_key_ref = "string"
        }
      }
      identifier             = "string"
      model                  = "string"
      url                    = "string"
      delegate_selectors     = ["string"]
      description            = "string"
      execute_on_delegate    = false
      ignore_test_connection = false
      name                   = "string"
      org_id                 = "string"
      project_id             = "string"
      tags                   = ["string"]
    }
    
    var connectorOpenaiModelResource = new ConnectorOpenaiModel("connectorOpenaiModelResource", ConnectorOpenaiModelArgs.builder()
        .auth(ConnectorOpenaiModelAuthArgs.builder()
            .authType("string")
            .token(ConnectorOpenaiModelAuthTokenArgs.builder()
                .tokenRef("string")
                .build())
            .vertex(ConnectorOpenaiModelAuthVertexArgs.builder()
                .projectId("string")
                .region("string")
                .serviceAccountKeyRef("string")
                .build())
            .build())
        .identifier("string")
        .model("string")
        .url("string")
        .delegateSelectors("string")
        .description("string")
        .executeOnDelegate(false)
        .ignoreTestConnection(false)
        .name("string")
        .orgId("string")
        .projectId("string")
        .tags("string")
        .build());
    
    connector_openai_model_resource = harness.platform.ConnectorOpenaiModel("connectorOpenaiModelResource",
        auth={
            "auth_type": "string",
            "token": {
                "token_ref": "string",
            },
            "vertex": {
                "project_id": "string",
                "region": "string",
                "service_account_key_ref": "string",
            },
        },
        identifier="string",
        model="string",
        url="string",
        delegate_selectors=["string"],
        description="string",
        execute_on_delegate=False,
        ignore_test_connection=False,
        name="string",
        org_id="string",
        project_id="string",
        tags=["string"])
    
    const connectorOpenaiModelResource = new harness.platform.ConnectorOpenaiModel("connectorOpenaiModelResource", {
        auth: {
            authType: "string",
            token: {
                tokenRef: "string",
            },
            vertex: {
                projectId: "string",
                region: "string",
                serviceAccountKeyRef: "string",
            },
        },
        identifier: "string",
        model: "string",
        url: "string",
        delegateSelectors: ["string"],
        description: "string",
        executeOnDelegate: false,
        ignoreTestConnection: false,
        name: "string",
        orgId: "string",
        projectId: "string",
        tags: ["string"],
    });
    
    type: harness:platform:ConnectorOpenaiModel
    properties:
        auth:
            authType: string
            token:
                tokenRef: string
            vertex:
                projectId: string
                region: string
                serviceAccountKeyRef: string
        delegateSelectors:
            - string
        description: string
        executeOnDelegate: false
        identifier: string
        ignoreTestConnection: false
        model: string
        name: string
        orgId: string
        projectId: string
        tags:
            - string
        url: string
    

    ConnectorOpenaiModel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ConnectorOpenaiModel resource accepts the following input properties:

    Auth ConnectorOpenaiModelAuth
    The authentication configuration for the OpenAI connector.
    Identifier string
    Unique identifier of the resource.
    Model string
    The OpenAI model to use (e.g. gpt-4o).
    Url string
    URL of the OpenAI API endpoint.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not. Default: true.
    IgnoreTestConnection bool
    Ignore test connection when creating or updating the connector. Default: false.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Auth ConnectorOpenaiModelAuthArgs
    The authentication configuration for the OpenAI connector.
    Identifier string
    Unique identifier of the resource.
    Model string
    The OpenAI model to use (e.g. gpt-4o).
    Url string
    URL of the OpenAI API endpoint.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not. Default: true.
    IgnoreTestConnection bool
    Ignore test connection when creating or updating the connector. Default: false.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    auth object
    The authentication configuration for the OpenAI connector.
    identifier string
    Unique identifier of the resource.
    model string
    The OpenAI model to use (e.g. gpt-4o).
    url string
    URL of the OpenAI API endpoint.
    delegate_selectors list(string)
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not. Default: true.
    ignore_test_connection bool
    Ignore test connection when creating or updating the connector. Default: false.
    name string
    Name of the resource.
    org_id string
    Unique identifier of the organization.
    project_id string
    Unique identifier of the project.
    tags list(string)
    Tags to associate with the resource.
    auth ConnectorOpenaiModelAuth
    The authentication configuration for the OpenAI connector.
    identifier String
    Unique identifier of the resource.
    model String
    The OpenAI model to use (e.g. gpt-4o).
    url String
    URL of the OpenAI API endpoint.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not. Default: true.
    ignoreTestConnection Boolean
    Ignore test connection when creating or updating the connector. Default: false.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    auth ConnectorOpenaiModelAuth
    The authentication configuration for the OpenAI connector.
    identifier string
    Unique identifier of the resource.
    model string
    The OpenAI model to use (e.g. gpt-4o).
    url string
    URL of the OpenAI API endpoint.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Execute on delegate or not. Default: true.
    ignoreTestConnection boolean
    Ignore test connection when creating or updating the connector. Default: false.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    auth ConnectorOpenaiModelAuthArgs
    The authentication configuration for the OpenAI connector.
    identifier str
    Unique identifier of the resource.
    model str
    The OpenAI model to use (e.g. gpt-4o).
    url str
    URL of the OpenAI API endpoint.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not. Default: true.
    ignore_test_connection bool
    Ignore test connection when creating or updating the connector. Default: false.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    auth Property Map
    The authentication configuration for the OpenAI connector.
    identifier String
    Unique identifier of the resource.
    model String
    The OpenAI model to use (e.g. gpt-4o).
    url String
    URL of the OpenAI API endpoint.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not. Default: true.
    ignoreTestConnection Boolean
    Ignore test connection when creating or updating the connector. Default: false.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConnectorOpenaiModel resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ConnectorOpenaiModel Resource

    Get an existing ConnectorOpenaiModel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConnectorOpenaiModelState, opts?: CustomResourceOptions): ConnectorOpenaiModel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auth: Optional[ConnectorOpenaiModelAuthArgs] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            execute_on_delegate: Optional[bool] = None,
            identifier: Optional[str] = None,
            ignore_test_connection: Optional[bool] = None,
            model: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            url: Optional[str] = None) -> ConnectorOpenaiModel
    func GetConnectorOpenaiModel(ctx *Context, name string, id IDInput, state *ConnectorOpenaiModelState, opts ...ResourceOption) (*ConnectorOpenaiModel, error)
    public static ConnectorOpenaiModel Get(string name, Input<string> id, ConnectorOpenaiModelState? state, CustomResourceOptions? opts = null)
    public static ConnectorOpenaiModel get(String name, Output<String> id, ConnectorOpenaiModelState state, CustomResourceOptions options)
    resources:  _:    type: harness:platform:ConnectorOpenaiModel    get:      id: ${id}
    import {
      to = harness_platform_connector_openai_model.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Auth ConnectorOpenaiModelAuth
    The authentication configuration for the OpenAI connector.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not. Default: true.
    Identifier string
    Unique identifier of the resource.
    IgnoreTestConnection bool
    Ignore test connection when creating or updating the connector. Default: false.
    Model string
    The OpenAI model to use (e.g. gpt-4o).
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Url string
    URL of the OpenAI API endpoint.
    Auth ConnectorOpenaiModelAuthArgs
    The authentication configuration for the OpenAI connector.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    ExecuteOnDelegate bool
    Execute on delegate or not. Default: true.
    Identifier string
    Unique identifier of the resource.
    IgnoreTestConnection bool
    Ignore test connection when creating or updating the connector. Default: false.
    Model string
    The OpenAI model to use (e.g. gpt-4o).
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    Url string
    URL of the OpenAI API endpoint.
    auth object
    The authentication configuration for the OpenAI connector.
    delegate_selectors list(string)
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not. Default: true.
    identifier string
    Unique identifier of the resource.
    ignore_test_connection bool
    Ignore test connection when creating or updating the connector. Default: false.
    model string
    The OpenAI model to use (e.g. gpt-4o).
    name string
    Name of the resource.
    org_id string
    Unique identifier of the organization.
    project_id string
    Unique identifier of the project.
    tags list(string)
    Tags to associate with the resource.
    url string
    URL of the OpenAI API endpoint.
    auth ConnectorOpenaiModelAuth
    The authentication configuration for the OpenAI connector.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not. Default: true.
    identifier String
    Unique identifier of the resource.
    ignoreTestConnection Boolean
    Ignore test connection when creating or updating the connector. Default: false.
    model String
    The OpenAI model to use (e.g. gpt-4o).
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the OpenAI API endpoint.
    auth ConnectorOpenaiModelAuth
    The authentication configuration for the OpenAI connector.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    executeOnDelegate boolean
    Execute on delegate or not. Default: true.
    identifier string
    Unique identifier of the resource.
    ignoreTestConnection boolean
    Ignore test connection when creating or updating the connector. Default: false.
    model string
    The OpenAI model to use (e.g. gpt-4o).
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    url string
    URL of the OpenAI API endpoint.
    auth ConnectorOpenaiModelAuthArgs
    The authentication configuration for the OpenAI connector.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    execute_on_delegate bool
    Execute on delegate or not. Default: true.
    identifier str
    Unique identifier of the resource.
    ignore_test_connection bool
    Ignore test connection when creating or updating the connector. Default: false.
    model str
    The OpenAI model to use (e.g. gpt-4o).
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    url str
    URL of the OpenAI API endpoint.
    auth Property Map
    The authentication configuration for the OpenAI connector.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    executeOnDelegate Boolean
    Execute on delegate or not. Default: true.
    identifier String
    Unique identifier of the resource.
    ignoreTestConnection Boolean
    Ignore test connection when creating or updating the connector. Default: false.
    model String
    The OpenAI model to use (e.g. gpt-4o).
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    URL of the OpenAI API endpoint.

    Supporting Types

    ConnectorOpenaiModelAuth, ConnectorOpenaiModelAuthArgs

    AuthType string
    Authentication type for the OpenAI connector. Valid values: Token, Vertex.
    Token ConnectorOpenaiModelAuthToken
    Authenticate using an OpenAI API token.
    Vertex ConnectorOpenaiModelAuthVertex
    Authenticate using Google Vertex AI credentials.
    AuthType string
    Authentication type for the OpenAI connector. Valid values: Token, Vertex.
    Token ConnectorOpenaiModelAuthToken
    Authenticate using an OpenAI API token.
    Vertex ConnectorOpenaiModelAuthVertex
    Authenticate using Google Vertex AI credentials.
    auth_type string
    Authentication type for the OpenAI connector. Valid values: Token, Vertex.
    token object
    Authenticate using an OpenAI API token.
    vertex object
    Authenticate using Google Vertex AI credentials.
    authType String
    Authentication type for the OpenAI connector. Valid values: Token, Vertex.
    token ConnectorOpenaiModelAuthToken
    Authenticate using an OpenAI API token.
    vertex ConnectorOpenaiModelAuthVertex
    Authenticate using Google Vertex AI credentials.
    authType string
    Authentication type for the OpenAI connector. Valid values: Token, Vertex.
    token ConnectorOpenaiModelAuthToken
    Authenticate using an OpenAI API token.
    vertex ConnectorOpenaiModelAuthVertex
    Authenticate using Google Vertex AI credentials.
    auth_type str
    Authentication type for the OpenAI connector. Valid values: Token, Vertex.
    token ConnectorOpenaiModelAuthToken
    Authenticate using an OpenAI API token.
    vertex ConnectorOpenaiModelAuthVertex
    Authenticate using Google Vertex AI credentials.
    authType String
    Authentication type for the OpenAI connector. Valid values: Token, Vertex.
    token Property Map
    Authenticate using an OpenAI API token.
    vertex Property Map
    Authenticate using Google Vertex AI credentials.

    ConnectorOpenaiModelAuthToken, ConnectorOpenaiModelAuthTokenArgs

    TokenRef string
    Reference to a secret containing the OpenAI API token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    TokenRef string
    Reference to a secret containing the OpenAI API token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    token_ref string
    Reference to a secret containing the OpenAI API token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    tokenRef String
    Reference to a secret containing the OpenAI API token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    tokenRef string
    Reference to a secret containing the OpenAI API token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    token_ref str
    Reference to a secret containing the OpenAI API token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    tokenRef String
    Reference to a secret containing the OpenAI API token. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.

    ConnectorOpenaiModelAuthVertex, ConnectorOpenaiModelAuthVertexArgs

    ProjectId string
    GCP project ID.
    Region string
    GCP region for the Vertex AI endpoint.
    ServiceAccountKeyRef string
    Reference to a secret containing the GCP service account key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    ProjectId string
    GCP project ID.
    Region string
    GCP region for the Vertex AI endpoint.
    ServiceAccountKeyRef string
    Reference to a secret containing the GCP service account key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    project_id string
    GCP project ID.
    region string
    GCP region for the Vertex AI endpoint.
    service_account_key_ref string
    Reference to a secret containing the GCP service account key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    projectId String
    GCP project ID.
    region String
    GCP region for the Vertex AI endpoint.
    serviceAccountKeyRef String
    Reference to a secret containing the GCP service account key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    projectId string
    GCP project ID.
    region string
    GCP region for the Vertex AI endpoint.
    serviceAccountKeyRef string
    Reference to a secret containing the GCP service account key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    project_id str
    GCP project ID.
    region str
    GCP region for the Vertex AI endpoint.
    service_account_key_ref str
    Reference to a secret containing the GCP service account key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.
    projectId String
    GCP project ID.
    region String
    GCP region for the Vertex AI endpoint.
    serviceAccountKeyRef String
    Reference to a secret containing the GCP service account key. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account' to the expression: account.{identifier}.

    Import

    Import account-level connector

    $ pulumi import harness:platform/connectorOpenaiModel:ConnectorOpenaiModel example <identifier>
    

    Import org-level connector

    $ pulumi import harness:platform/connectorOpenaiModel:ConnectorOpenaiModel example <org_id>/<identifier>
    

    Import project-level connector

    $ pulumi import harness:platform/connectorOpenaiModel:ConnectorOpenaiModel example <org_id>/<project_id>/<identifier>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.17.6
    published on Saturday, Oct 31, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial