Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. GenericOidcAccount
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.GenericOidcAccount

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages a Generic OIDC Account in Octopus Deploy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";

const example = new octopusdeploy.GenericOidcAccount("example", {
    audience: "api://default",
    executionSubjectKeys: [
        "space",
        "project",
    ],
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.GenericOidcAccount("example",
    audience="api://default",
    execution_subject_keys=[
        "space",
        "project",
    ])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewGenericOidcAccount(ctx, "example", &octopusdeploy.GenericOidcAccountArgs{
			Audience: pulumi.String("api://default"),
			ExecutionSubjectKeys: pulumi.StringArray{
				pulumi.String("space"),
				pulumi.String("project"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.GenericOidcAccount("example", new()
    {
        Audience = "api://default",
        ExecutionSubjectKeys = new[]
        {
            "space",
            "project",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.GenericOidcAccount;
import com.pulumi.octopusdeploy.GenericOidcAccountArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new GenericOidcAccount("example", GenericOidcAccountArgs.builder()
            .audience("api://default")
            .executionSubjectKeys(            
                "space",
                "project")
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:GenericOidcAccount
    properties:
      audience: api://default
      executionSubjectKeys:
        - space
        - project

    Create GenericOidcAccount Resource

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

    Constructor syntax

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

@overload
def GenericOidcAccount(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       audience: Optional[str] = None,
                       description: Optional[str] = None,
                       environments: Optional[Sequence[str]] = None,
                       execution_subject_keys: Optional[Sequence[str]] = None,
                       name: Optional[str] = None,
                       space_id: Optional[str] = None,
                       tenant_tags: Optional[Sequence[str]] = None,
                       tenanted_deployment_participation: Optional[str] = None,
                       tenants: Optional[Sequence[str]] = None)
    func NewGenericOidcAccount(ctx *Context, name string, args *GenericOidcAccountArgs, opts ...ResourceOption) (*GenericOidcAccount, error)
    public GenericOidcAccount(string name, GenericOidcAccountArgs? args = null, CustomResourceOptions? opts = null)
    public GenericOidcAccount(String name, GenericOidcAccountArgs args)
public GenericOidcAccount(String name, GenericOidcAccountArgs args, CustomResourceOptions options)

    type: octopusdeploy:GenericOidcAccount
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GenericOidcAccountArgs
    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 GenericOidcAccountArgs
    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 GenericOidcAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GenericOidcAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GenericOidcAccountArgs
    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 genericOidcAccountResource = new Octopusdeploy.GenericOidcAccount("genericOidcAccountResource", new()
{
    Audience = "string",
    Description = "string",
    Environments = new[]
    {
        "string",
    },
    ExecutionSubjectKeys = new[]
    {
        "string",
    },
    Name = "string",
    SpaceId = "string",
    TenantTags = new[]
    {
        "string",
    },
    TenantedDeploymentParticipation = "string",
    Tenants = new[]
    {
        "string",
    },
});

    example, err := octopusdeploy.NewGenericOidcAccount(ctx, "genericOidcAccountResource", &octopusdeploy.GenericOidcAccountArgs{
	Audience:    pulumi.String("string"),
	Description: pulumi.String("string"),
	Environments: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExecutionSubjectKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	SpaceId: pulumi.String("string"),
	TenantTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantedDeploymentParticipation: pulumi.String("string"),
	Tenants: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var genericOidcAccountResource = new GenericOidcAccount("genericOidcAccountResource", GenericOidcAccountArgs.builder()
    .audience("string")
    .description("string")
    .environments("string")
    .executionSubjectKeys("string")
    .name("string")
    .spaceId("string")
    .tenantTags("string")
    .tenantedDeploymentParticipation("string")
    .tenants("string")
    .build());

    generic_oidc_account_resource = octopusdeploy.GenericOidcAccount("genericOidcAccountResource",
    audience="string",
    description="string",
    environments=["string"],
    execution_subject_keys=["string"],
    name="string",
    space_id="string",
    tenant_tags=["string"],
    tenanted_deployment_participation="string",
    tenants=["string"])

    const genericOidcAccountResource = new octopusdeploy.GenericOidcAccount("genericOidcAccountResource", {
    audience: "string",
    description: "string",
    environments: ["string"],
    executionSubjectKeys: ["string"],
    name: "string",
    spaceId: "string",
    tenantTags: ["string"],
    tenantedDeploymentParticipation: "string",
    tenants: ["string"],
});

    type: octopusdeploy:GenericOidcAccount
properties:
    audience: string
    description: string
    environments:
        - string
    executionSubjectKeys:
        - string
    name: string
    spaceId: string
    tenantTags:
        - string
    tenantedDeploymentParticipation: string
    tenants:
        - string

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

    Audience string
    The audience associated with this resource.
    Description string
    The description of this generic oidc account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys List<string>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    Name string
    The name of the generic oidc account.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    Audience string
    The audience associated with this resource.
    Description string
    The description of this generic oidc account.
    Environments []string
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys []string
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    Name string
    The name of the generic oidc account.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    audience String
    The audience associated with this resource.
    description String
    The description of this generic oidc account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name String
    The name of the generic oidc account.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    audience string
    The audience associated with this resource.
    description string
    The description of this generic oidc account.
    environments string[]
    A list of environment IDs associated with this resource.
    executionSubjectKeys string[]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name string
    The name of the generic oidc account.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    audience str
    The audience associated with this resource.
    description str
    The description of this generic oidc account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    execution_subject_keys Sequence[str]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name str
    The name of the generic oidc account.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    audience String
    The audience associated with this resource.
    description String
    The description of this generic oidc account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name String
    The name of the generic oidc account.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GenericOidcAccount 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GenericOidcAccount Resource

    Get an existing GenericOidcAccount 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?: GenericOidcAccountState, opts?: CustomResourceOptions): GenericOidcAccount
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audience: Optional[str] = None,
        description: Optional[str] = None,
        environments: Optional[Sequence[str]] = None,
        execution_subject_keys: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        space_id: Optional[str] = None,
        tenant_tags: Optional[Sequence[str]] = None,
        tenanted_deployment_participation: Optional[str] = None,
        tenants: Optional[Sequence[str]] = None) -> GenericOidcAccount
    func GetGenericOidcAccount(ctx *Context, name string, id IDInput, state *GenericOidcAccountState, opts ...ResourceOption) (*GenericOidcAccount, error)
    public static GenericOidcAccount Get(string name, Input<string> id, GenericOidcAccountState? state, CustomResourceOptions? opts = null)
    public static GenericOidcAccount get(String name, Output<String> id, GenericOidcAccountState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:GenericOidcAccount    get:      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:
    Audience string
    The audience associated with this resource.
    Description string
    The description of this generic oidc account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys List<string>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    Name string
    The name of the generic oidc account.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    Audience string
    The audience associated with this resource.
    Description string
    The description of this generic oidc account.
    Environments []string
    A list of environment IDs associated with this resource.
    ExecutionSubjectKeys []string
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    Name string
    The name of the generic oidc account.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    audience String
    The audience associated with this resource.
    description String
    The description of this generic oidc account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name String
    The name of the generic oidc account.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    audience string
    The audience associated with this resource.
    description string
    The description of this generic oidc account.
    environments string[]
    A list of environment IDs associated with this resource.
    executionSubjectKeys string[]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name string
    The name of the generic oidc account.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    audience str
    The audience associated with this resource.
    description str
    The description of this generic oidc account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    execution_subject_keys Sequence[str]
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name str
    The name of the generic oidc account.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    audience String
    The audience associated with this resource.
    description String
    The description of this generic oidc account.
    environments List<String>
    A list of environment IDs associated with this resource.
    executionSubjectKeys List<String>
    Keys to include in a deployment or runbook. Valid options are space, environment, project, tenant, runbook, account, type.
    name String
    The name of the generic oidc account.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    Import

    $ pulumi import octopusdeploy:index/genericOidcAccount:GenericOidcAccount [options] octopusdeploy_generic_oidc_account.<name> <account-id>

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

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy