Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Harness Provider
  4. API Docs
  5. platform
  6. IdpPlugin
Viewing docs for Harness v0.16.5
published on Saturday, Sep 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

harness.platform.IdpPlugin

harness logo
Viewing docs for Harness v0.16.5
published on Saturday, Sep 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

    Resource for managing IDP plugin configurations.

    Create IdpPlugin Resource

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

    Constructor syntax

    new IdpPlugin(name: string, args: IdpPluginArgs, opts?: CustomResourceOptions);
    @overload
def IdpPlugin(resource_name: str,
              args: IdpPluginArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def IdpPlugin(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              configs: Optional[str] = None,
              identifier: Optional[str] = None,
              enabled: Optional[bool] = None,
              env_variables: Optional[Sequence[IdpPluginEnvVariableArgs]] = None,
              name: Optional[str] = None,
              proxies: Optional[Sequence[IdpPluginProxyArgs]] = None)
    func NewIdpPlugin(ctx *Context, name string, args IdpPluginArgs, opts ...ResourceOption) (*IdpPlugin, error)
    public IdpPlugin(string name, IdpPluginArgs args, CustomResourceOptions? opts = null)
    public IdpPlugin(String name, IdpPluginArgs args)
public IdpPlugin(String name, IdpPluginArgs args, CustomResourceOptions options)

    type: harness:platform:IdpPlugin
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "harness_platform_idp_plugin" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IdpPluginArgs
    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 IdpPluginArgs
    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 IdpPluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdpPluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdpPluginArgs
    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 idpPluginResource = new Harness.Platform.IdpPlugin("idpPluginResource", new()
{
    Configs = "string",
    Identifier = "string",
    Enabled = false,
    EnvVariables = new[]
    {
        new Harness.Platform.Inputs.IdpPluginEnvVariableArgs
        {
            EnvName = "string",
            HarnessSecretIdentifier = "string",
            Type = "string",
            Identifier = "string",
        },
    },
    Name = "string",
    Proxies = new[]
    {
        new Harness.Platform.Inputs.IdpPluginProxyArgs
        {
            Host = "string",
            HealthCheckPath = "string",
            Identifier = "string",
            Proxy = false,
            Selectors = new[]
            {
                "string",
            },
        },
    },
});

    example, err := platform.NewIdpPlugin(ctx, "idpPluginResource", &platform.IdpPluginArgs{
	Configs:    pulumi.String("string"),
	Identifier: pulumi.String("string"),
	Enabled:    pulumi.Bool(false),
	EnvVariables: platform.IdpPluginEnvVariableArray{
		&platform.IdpPluginEnvVariableArgs{
			EnvName:                 pulumi.String("string"),
			HarnessSecretIdentifier: pulumi.String("string"),
			Type:                    pulumi.String("string"),
			Identifier:              pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Proxies: platform.IdpPluginProxyArray{
		&platform.IdpPluginProxyArgs{
			Host:            pulumi.String("string"),
			HealthCheckPath: pulumi.String("string"),
			Identifier:      pulumi.String("string"),
			Proxy:           pulumi.Bool(false),
			Selectors: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})

    resource "harness_platform_idp_plugin" "idpPluginResource" {
  lifecycle {
    create_before_destroy = true
  }
  configs    = "string"
  identifier = "string"
  enabled    = false
  env_variables {
    env_name                  = "string"
    harness_secret_identifier = "string"
    type                      = "string"
    identifier                = "string"
  }
  name = "string"
  proxies {
    host              = "string"
    health_check_path = "string"
    identifier        = "string"
    proxy             = false
    selectors         = ["string"]
  }
}

    var idpPluginResource = new IdpPlugin("idpPluginResource", IdpPluginArgs.builder()
    .configs("string")
    .identifier("string")
    .enabled(false)
    .envVariables(IdpPluginEnvVariableArgs.builder()
        .envName("string")
        .harnessSecretIdentifier("string")
        .type("string")
        .identifier("string")
        .build())
    .name("string")
    .proxies(IdpPluginProxyArgs.builder()
        .host("string")
        .healthCheckPath("string")
        .identifier("string")
        .proxy(false)
        .selectors("string")
        .build())
    .build());

    idp_plugin_resource = harness.platform.IdpPlugin("idpPluginResource",
    configs="string",
    identifier="string",
    enabled=False,
    env_variables=[{
        "env_name": "string",
        "harness_secret_identifier": "string",
        "type": "string",
        "identifier": "string",
    }],
    name="string",
    proxies=[{
        "host": "string",
        "health_check_path": "string",
        "identifier": "string",
        "proxy": False,
        "selectors": ["string"],
    }])

    const idpPluginResource = new harness.platform.IdpPlugin("idpPluginResource", {
    configs: "string",
    identifier: "string",
    enabled: false,
    envVariables: [{
        envName: "string",
        harnessSecretIdentifier: "string",
        type: "string",
        identifier: "string",
    }],
    name: "string",
    proxies: [{
        host: "string",
        healthCheckPath: "string",
        identifier: "string",
        proxy: false,
        selectors: ["string"],
    }],
});

    type: harness:platform:IdpPlugin
properties:
    configs: string
    enabled: false
    envVariables:
        - envName: string
          harnessSecretIdentifier: string
          identifier: string
          type: string
    identifier: string
    name: string
    proxies:
        - healthCheckPath: string
          host: string
          identifier: string
          proxy: false
          selectors:
            - string

    IdpPlugin 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 IdpPlugin resource accepts the following input properties:

    Configs string
    Backstage YAML configuration for the plugin.
    Identifier string
    Unique identifier of the plugin.
    Enabled bool
    Whether the plugin should be enabled. Defaults to true.
    EnvVariables List<IdpPluginEnvVariable>
    Secret environment variables injected into the plugin runtime.
    Name string
    Display name of the plugin configuration.
    Proxies List<IdpPluginProxy>
    Delegate-based proxy configuration for outbound HTTP calls.
    Configs string
    Backstage YAML configuration for the plugin.
    Identifier string
    Unique identifier of the plugin.
    Enabled bool
    Whether the plugin should be enabled. Defaults to true.
    EnvVariables []IdpPluginEnvVariableArgs
    Secret environment variables injected into the plugin runtime.
    Name string
    Display name of the plugin configuration.
    Proxies []IdpPluginProxyArgs
    Delegate-based proxy configuration for outbound HTTP calls.
    configs string
    Backstage YAML configuration for the plugin.
    identifier string
    Unique identifier of the plugin.
    enabled bool
    Whether the plugin should be enabled. Defaults to true.
    env_variables list(object)
    Secret environment variables injected into the plugin runtime.
    name string
    Display name of the plugin configuration.
    proxies list(object)
    Delegate-based proxy configuration for outbound HTTP calls.
    configs String
    Backstage YAML configuration for the plugin.
    identifier String
    Unique identifier of the plugin.
    enabled Boolean
    Whether the plugin should be enabled. Defaults to true.
    envVariables List<IdpPluginEnvVariable>
    Secret environment variables injected into the plugin runtime.
    name String
    Display name of the plugin configuration.
    proxies List<IdpPluginProxy>
    Delegate-based proxy configuration for outbound HTTP calls.
    configs string
    Backstage YAML configuration for the plugin.
    identifier string
    Unique identifier of the plugin.
    enabled boolean
    Whether the plugin should be enabled. Defaults to true.
    envVariables IdpPluginEnvVariable[]
    Secret environment variables injected into the plugin runtime.
    name string
    Display name of the plugin configuration.
    proxies IdpPluginProxy[]
    Delegate-based proxy configuration for outbound HTTP calls.
    configs str
    Backstage YAML configuration for the plugin.
    identifier str
    Unique identifier of the plugin.
    enabled bool
    Whether the plugin should be enabled. Defaults to true.
    env_variables Sequence[IdpPluginEnvVariableArgs]
    Secret environment variables injected into the plugin runtime.
    name str
    Display name of the plugin configuration.
    proxies Sequence[IdpPluginProxyArgs]
    Delegate-based proxy configuration for outbound HTTP calls.
    configs String
    Backstage YAML configuration for the plugin.
    identifier String
    Unique identifier of the plugin.
    enabled Boolean
    Whether the plugin should be enabled. Defaults to true.
    envVariables List<Property Map>
    Secret environment variables injected into the plugin runtime.
    name String
    Display name of the plugin configuration.
    proxies List<Property Map>
    Delegate-based proxy configuration for outbound HTTP calls.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdpPlugin 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 IdpPlugin Resource

    Get an existing IdpPlugin 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?: IdpPluginState, opts?: CustomResourceOptions): IdpPlugin
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configs: Optional[str] = None,
        enabled: Optional[bool] = None,
        env_variables: Optional[Sequence[IdpPluginEnvVariableArgs]] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        proxies: Optional[Sequence[IdpPluginProxyArgs]] = None) -> IdpPlugin
    func GetIdpPlugin(ctx *Context, name string, id IDInput, state *IdpPluginState, opts ...ResourceOption) (*IdpPlugin, error)
    public static IdpPlugin Get(string name, Input<string> id, IdpPluginState? state, CustomResourceOptions? opts = null)
    public static IdpPlugin get(String name, Output<String> id, IdpPluginState state, CustomResourceOptions options)
    resources:  _:    type: harness:platform:IdpPlugin    get:      id: ${id}
    import {
  to = harness_platform_idp_plugin.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:
    Configs string
    Backstage YAML configuration for the plugin.
    Enabled bool
    Whether the plugin should be enabled. Defaults to true.
    EnvVariables List<IdpPluginEnvVariable>
    Secret environment variables injected into the plugin runtime.
    Identifier string
    Unique identifier of the plugin.
    Name string
    Display name of the plugin configuration.
    Proxies List<IdpPluginProxy>
    Delegate-based proxy configuration for outbound HTTP calls.
    Configs string
    Backstage YAML configuration for the plugin.
    Enabled bool
    Whether the plugin should be enabled. Defaults to true.
    EnvVariables []IdpPluginEnvVariableArgs
    Secret environment variables injected into the plugin runtime.
    Identifier string
    Unique identifier of the plugin.
    Name string
    Display name of the plugin configuration.
    Proxies []IdpPluginProxyArgs
    Delegate-based proxy configuration for outbound HTTP calls.
    configs string
    Backstage YAML configuration for the plugin.
    enabled bool
    Whether the plugin should be enabled. Defaults to true.
    env_variables list(object)
    Secret environment variables injected into the plugin runtime.
    identifier string
    Unique identifier of the plugin.
    name string
    Display name of the plugin configuration.
    proxies list(object)
    Delegate-based proxy configuration for outbound HTTP calls.
    configs String
    Backstage YAML configuration for the plugin.
    enabled Boolean
    Whether the plugin should be enabled. Defaults to true.
    envVariables List<IdpPluginEnvVariable>
    Secret environment variables injected into the plugin runtime.
    identifier String
    Unique identifier of the plugin.
    name String
    Display name of the plugin configuration.
    proxies List<IdpPluginProxy>
    Delegate-based proxy configuration for outbound HTTP calls.
    configs string
    Backstage YAML configuration for the plugin.
    enabled boolean
    Whether the plugin should be enabled. Defaults to true.
    envVariables IdpPluginEnvVariable[]
    Secret environment variables injected into the plugin runtime.
    identifier string
    Unique identifier of the plugin.
    name string
    Display name of the plugin configuration.
    proxies IdpPluginProxy[]
    Delegate-based proxy configuration for outbound HTTP calls.
    configs str
    Backstage YAML configuration for the plugin.
    enabled bool
    Whether the plugin should be enabled. Defaults to true.
    env_variables Sequence[IdpPluginEnvVariableArgs]
    Secret environment variables injected into the plugin runtime.
    identifier str
    Unique identifier of the plugin.
    name str
    Display name of the plugin configuration.
    proxies Sequence[IdpPluginProxyArgs]
    Delegate-based proxy configuration for outbound HTTP calls.
    configs String
    Backstage YAML configuration for the plugin.
    enabled Boolean
    Whether the plugin should be enabled. Defaults to true.
    envVariables List<Property Map>
    Secret environment variables injected into the plugin runtime.
    identifier String
    Unique identifier of the plugin.
    name String
    Display name of the plugin configuration.
    proxies List<Property Map>
    Delegate-based proxy configuration for outbound HTTP calls.

    Supporting Types

    IdpPluginEnvVariable, IdpPluginEnvVariableArgs

    EnvName string
    Name of the environment variable.
    HarnessSecretIdentifier string
    Harness secret identifier used as the value.
    Type string
    Type of the environment variable source. Valid values: Secret, Config.
    Identifier string
    Server-generated unique identifier for this env variable entry.
    EnvName string
    Name of the environment variable.
    HarnessSecretIdentifier string
    Harness secret identifier used as the value.
    Type string
    Type of the environment variable source. Valid values: Secret, Config.
    Identifier string
    Server-generated unique identifier for this env variable entry.
    env_name string
    Name of the environment variable.
    harness_secret_identifier string
    Harness secret identifier used as the value.
    type string
    Type of the environment variable source. Valid values: Secret, Config.
    identifier string
    Server-generated unique identifier for this env variable entry.
    envName String
    Name of the environment variable.
    harnessSecretIdentifier String
    Harness secret identifier used as the value.
    type String
    Type of the environment variable source. Valid values: Secret, Config.
    identifier String
    Server-generated unique identifier for this env variable entry.
    envName string
    Name of the environment variable.
    harnessSecretIdentifier string
    Harness secret identifier used as the value.
    type string
    Type of the environment variable source. Valid values: Secret, Config.
    identifier string
    Server-generated unique identifier for this env variable entry.
    env_name str
    Name of the environment variable.
    harness_secret_identifier str
    Harness secret identifier used as the value.
    type str
    Type of the environment variable source. Valid values: Secret, Config.
    identifier str
    Server-generated unique identifier for this env variable entry.
    envName String
    Name of the environment variable.
    harnessSecretIdentifier String
    Harness secret identifier used as the value.
    type String
    Type of the environment variable source. Valid values: Secret, Config.
    identifier String
    Server-generated unique identifier for this env variable entry.

    IdpPluginProxy, IdpPluginProxyArgs

    Host string
    Proxy host.
    HealthCheckPath string
    Health check path for the proxy endpoint.
    Identifier string
    Server-generated unique identifier for this proxy entry.
    Proxy bool
    Whether proxy is enabled for this host.
    Selectors List<string>
    Delegate selectors.
    Host string
    Proxy host.
    HealthCheckPath string
    Health check path for the proxy endpoint.
    Identifier string
    Server-generated unique identifier for this proxy entry.
    Proxy bool
    Whether proxy is enabled for this host.
    Selectors []string
    Delegate selectors.
    host string
    Proxy host.
    health_check_path string
    Health check path for the proxy endpoint.
    identifier string
    Server-generated unique identifier for this proxy entry.
    proxy bool
    Whether proxy is enabled for this host.
    selectors list(string)
    Delegate selectors.
    host String
    Proxy host.
    healthCheckPath String
    Health check path for the proxy endpoint.
    identifier String
    Server-generated unique identifier for this proxy entry.
    proxy Boolean
    Whether proxy is enabled for this host.
    selectors List<String>
    Delegate selectors.
    host string
    Proxy host.
    healthCheckPath string
    Health check path for the proxy endpoint.
    identifier string
    Server-generated unique identifier for this proxy entry.
    proxy boolean
    Whether proxy is enabled for this host.
    selectors string[]
    Delegate selectors.
    host str
    Proxy host.
    health_check_path str
    Health check path for the proxy endpoint.
    identifier str
    Server-generated unique identifier for this proxy entry.
    proxy bool
    Whether proxy is enabled for this host.
    selectors Sequence[str]
    Delegate selectors.
    host String
    Proxy host.
    healthCheckPath String
    Health check path for the proxy endpoint.
    identifier String
    Server-generated unique identifier for this proxy entry.
    proxy Boolean
    Whether proxy is enabled for this host.
    selectors List<String>
    Delegate selectors.

    Import

    The pulumi import command can be used, for example:

    Import an IDP plugin by its identifier

    $ pulumi import harness:platform/idpPlugin:IdpPlugin example <plugin_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.16.5
    published on Saturday, Sep 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-harness

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial