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

octopusdeploy.Team

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 teams in Octopus Deploy.

    NOTE on Team User Roles and Scoped User Roles: We currently provides both a standalone Scoped User Role resource and a Team resource with user_roles blocks defined in-line. At this time you cannot use a Team with in-line user_roles in conjunction with any Scoped User Role resources. Doing so will cause a conflict of user role settings and will overwrite user roles.

    Create Team Resource

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

    Constructor syntax

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

@overload
def Team(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         can_be_deleted: Optional[bool] = None,
         can_be_renamed: Optional[bool] = None,
         can_change_members: Optional[bool] = None,
         can_change_roles: Optional[bool] = None,
         description: Optional[str] = None,
         external_security_groups: Optional[Sequence[TeamExternalSecurityGroupArgs]] = None,
         name: Optional[str] = None,
         space_id: Optional[str] = None,
         team_id: Optional[str] = None,
         user_roles: Optional[Sequence[TeamUserRoleArgs]] = None,
         users: Optional[Sequence[str]] = None)
    func NewTeam(ctx *Context, name string, args *TeamArgs, opts ...ResourceOption) (*Team, error)
    public Team(string name, TeamArgs? args = null, CustomResourceOptions? opts = null)
    public Team(String name, TeamArgs args)
public Team(String name, TeamArgs args, CustomResourceOptions options)

    type: octopusdeploy:Team
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 TeamArgs
    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 TeamArgs
    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 TeamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamArgs
    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 teamResource = new Octopusdeploy.Team("teamResource", new()
{
    CanBeDeleted = false,
    CanBeRenamed = false,
    CanChangeMembers = false,
    CanChangeRoles = false,
    Description = "string",
    ExternalSecurityGroups = new[]
    {
        new Octopusdeploy.Inputs.TeamExternalSecurityGroupArgs
        {
            DisplayIdAndName = false,
            DisplayName = "string",
            Id = "string",
        },
    },
    Name = "string",
    SpaceId = "string",
    TeamId = "string",
    UserRoles = new[]
    {
        new Octopusdeploy.Inputs.TeamUserRoleArgs
        {
            SpaceId = "string",
            UserRoleId = "string",
            EnvironmentIds = new[]
            {
                "string",
            },
            Id = "string",
            ProjectGroupIds = new[]
            {
                "string",
            },
            ProjectIds = new[]
            {
                "string",
            },
            TeamId = "string",
            TenantIds = new[]
            {
                "string",
            },
        },
    },
    Users = new[]
    {
        "string",
    },
});

    example, err := octopusdeploy.NewTeam(ctx, "teamResource", &octopusdeploy.TeamArgs{
	CanBeDeleted:     pulumi.Bool(false),
	CanBeRenamed:     pulumi.Bool(false),
	CanChangeMembers: pulumi.Bool(false),
	CanChangeRoles:   pulumi.Bool(false),
	Description:      pulumi.String("string"),
	ExternalSecurityGroups: octopusdeploy.TeamExternalSecurityGroupArray{
		&octopusdeploy.TeamExternalSecurityGroupArgs{
			DisplayIdAndName: pulumi.Bool(false),
			DisplayName:      pulumi.String("string"),
			Id:               pulumi.String("string"),
		},
	},
	Name:    pulumi.String("string"),
	SpaceId: pulumi.String("string"),
	TeamId:  pulumi.String("string"),
	UserRoles: octopusdeploy.TeamUserRoleArray{
		&octopusdeploy.TeamUserRoleArgs{
			SpaceId:    pulumi.String("string"),
			UserRoleId: pulumi.String("string"),
			EnvironmentIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			Id: pulumi.String("string"),
			ProjectGroupIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			ProjectIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			TeamId: pulumi.String("string"),
			TenantIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Users: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var teamResource = new Team("teamResource", TeamArgs.builder()
    .canBeDeleted(false)
    .canBeRenamed(false)
    .canChangeMembers(false)
    .canChangeRoles(false)
    .description("string")
    .externalSecurityGroups(TeamExternalSecurityGroupArgs.builder()
        .displayIdAndName(false)
        .displayName("string")
        .id("string")
        .build())
    .name("string")
    .spaceId("string")
    .teamId("string")
    .userRoles(TeamUserRoleArgs.builder()
        .spaceId("string")
        .userRoleId("string")
        .environmentIds("string")
        .id("string")
        .projectGroupIds("string")
        .projectIds("string")
        .teamId("string")
        .tenantIds("string")
        .build())
    .users("string")
    .build());

    team_resource = octopusdeploy.Team("teamResource",
    can_be_deleted=False,
    can_be_renamed=False,
    can_change_members=False,
    can_change_roles=False,
    description="string",
    external_security_groups=[{
        "display_id_and_name": False,
        "display_name": "string",
        "id": "string",
    }],
    name="string",
    space_id="string",
    team_id="string",
    user_roles=[{
        "space_id": "string",
        "user_role_id": "string",
        "environment_ids": ["string"],
        "id": "string",
        "project_group_ids": ["string"],
        "project_ids": ["string"],
        "team_id": "string",
        "tenant_ids": ["string"],
    }],
    users=["string"])

    const teamResource = new octopusdeploy.Team("teamResource", {
    canBeDeleted: false,
    canBeRenamed: false,
    canChangeMembers: false,
    canChangeRoles: false,
    description: "string",
    externalSecurityGroups: [{
        displayIdAndName: false,
        displayName: "string",
        id: "string",
    }],
    name: "string",
    spaceId: "string",
    teamId: "string",
    userRoles: [{
        spaceId: "string",
        userRoleId: "string",
        environmentIds: ["string"],
        id: "string",
        projectGroupIds: ["string"],
        projectIds: ["string"],
        teamId: "string",
        tenantIds: ["string"],
    }],
    users: ["string"],
});

    type: octopusdeploy:Team
properties:
    canBeDeleted: false
    canBeRenamed: false
    canChangeMembers: false
    canChangeRoles: false
    description: string
    externalSecurityGroups:
        - displayIdAndName: false
          displayName: string
          id: string
    name: string
    spaceId: string
    teamId: string
    userRoles:
        - environmentIds:
            - string
          id: string
          projectGroupIds:
            - string
          projectIds:
            - string
          spaceId: string
          teamId: string
          tenantIds:
            - string
          userRoleId: string
    users:
        - string

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

    CanBeDeleted bool
    CanBeRenamed bool
    CanChangeMembers bool
    CanChangeRoles bool
    Description string
    The user-friendly description of this team.
    ExternalSecurityGroups List<TeamExternalSecurityGroup>
    Name string
    The name of this team.
    SpaceId string
    The space associated with this team.
    TeamId string
    The unique ID for this resource.
    UserRoles List<TeamUserRole>
    Users List<string>
    A list of user IDs designated to be members of this team.
    CanBeDeleted bool
    CanBeRenamed bool
    CanChangeMembers bool
    CanChangeRoles bool
    Description string
    The user-friendly description of this team.
    ExternalSecurityGroups []TeamExternalSecurityGroupArgs
    Name string
    The name of this team.
    SpaceId string
    The space associated with this team.
    TeamId string
    The unique ID for this resource.
    UserRoles []TeamUserRoleArgs
    Users []string
    A list of user IDs designated to be members of this team.
    canBeDeleted Boolean
    canBeRenamed Boolean
    canChangeMembers Boolean
    canChangeRoles Boolean
    description String
    The user-friendly description of this team.
    externalSecurityGroups List<TeamExternalSecurityGroup>
    name String
    The name of this team.
    spaceId String
    The space associated with this team.
    teamId String
    The unique ID for this resource.
    userRoles List<TeamUserRole>
    users List<String>
    A list of user IDs designated to be members of this team.
    canBeDeleted boolean
    canBeRenamed boolean
    canChangeMembers boolean
    canChangeRoles boolean
    description string
    The user-friendly description of this team.
    externalSecurityGroups TeamExternalSecurityGroup[]
    name string
    The name of this team.
    spaceId string
    The space associated with this team.
    teamId string
    The unique ID for this resource.
    userRoles TeamUserRole[]
    users string[]
    A list of user IDs designated to be members of this team.
    can_be_deleted bool
    can_be_renamed bool
    can_change_members bool
    can_change_roles bool
    description str
    The user-friendly description of this team.
    external_security_groups Sequence[TeamExternalSecurityGroupArgs]
    name str
    The name of this team.
    space_id str
    The space associated with this team.
    team_id str
    The unique ID for this resource.
    user_roles Sequence[TeamUserRoleArgs]
    users Sequence[str]
    A list of user IDs designated to be members of this team.
    canBeDeleted Boolean
    canBeRenamed Boolean
    canChangeMembers Boolean
    canChangeRoles Boolean
    description String
    The user-friendly description of this team.
    externalSecurityGroups List<Property Map>
    name String
    The name of this team.
    spaceId String
    The space associated with this team.
    teamId String
    The unique ID for this resource.
    userRoles List<Property Map>
    users List<String>
    A list of user IDs designated to be members of this team.

    Outputs

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

    Get an existing Team 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?: TeamState, opts?: CustomResourceOptions): Team
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        can_be_deleted: Optional[bool] = None,
        can_be_renamed: Optional[bool] = None,
        can_change_members: Optional[bool] = None,
        can_change_roles: Optional[bool] = None,
        description: Optional[str] = None,
        external_security_groups: Optional[Sequence[TeamExternalSecurityGroupArgs]] = None,
        name: Optional[str] = None,
        space_id: Optional[str] = None,
        team_id: Optional[str] = None,
        user_roles: Optional[Sequence[TeamUserRoleArgs]] = None,
        users: Optional[Sequence[str]] = None) -> Team
    func GetTeam(ctx *Context, name string, id IDInput, state *TeamState, opts ...ResourceOption) (*Team, error)
    public static Team Get(string name, Input<string> id, TeamState? state, CustomResourceOptions? opts = null)
    public static Team get(String name, Output<String> id, TeamState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:Team    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:
    CanBeDeleted bool
    CanBeRenamed bool
    CanChangeMembers bool
    CanChangeRoles bool
    Description string
    The user-friendly description of this team.
    ExternalSecurityGroups List<TeamExternalSecurityGroup>
    Name string
    The name of this team.
    SpaceId string
    The space associated with this team.
    TeamId string
    The unique ID for this resource.
    UserRoles List<TeamUserRole>
    Users List<string>
    A list of user IDs designated to be members of this team.
    CanBeDeleted bool
    CanBeRenamed bool
    CanChangeMembers bool
    CanChangeRoles bool
    Description string
    The user-friendly description of this team.
    ExternalSecurityGroups []TeamExternalSecurityGroupArgs
    Name string
    The name of this team.
    SpaceId string
    The space associated with this team.
    TeamId string
    The unique ID for this resource.
    UserRoles []TeamUserRoleArgs
    Users []string
    A list of user IDs designated to be members of this team.
    canBeDeleted Boolean
    canBeRenamed Boolean
    canChangeMembers Boolean
    canChangeRoles Boolean
    description String
    The user-friendly description of this team.
    externalSecurityGroups List<TeamExternalSecurityGroup>
    name String
    The name of this team.
    spaceId String
    The space associated with this team.
    teamId String
    The unique ID for this resource.
    userRoles List<TeamUserRole>
    users List<String>
    A list of user IDs designated to be members of this team.
    canBeDeleted boolean
    canBeRenamed boolean
    canChangeMembers boolean
    canChangeRoles boolean
    description string
    The user-friendly description of this team.
    externalSecurityGroups TeamExternalSecurityGroup[]
    name string
    The name of this team.
    spaceId string
    The space associated with this team.
    teamId string
    The unique ID for this resource.
    userRoles TeamUserRole[]
    users string[]
    A list of user IDs designated to be members of this team.
    can_be_deleted bool
    can_be_renamed bool
    can_change_members bool
    can_change_roles bool
    description str
    The user-friendly description of this team.
    external_security_groups Sequence[TeamExternalSecurityGroupArgs]
    name str
    The name of this team.
    space_id str
    The space associated with this team.
    team_id str
    The unique ID for this resource.
    user_roles Sequence[TeamUserRoleArgs]
    users Sequence[str]
    A list of user IDs designated to be members of this team.
    canBeDeleted Boolean
    canBeRenamed Boolean
    canChangeMembers Boolean
    canChangeRoles Boolean
    description String
    The user-friendly description of this team.
    externalSecurityGroups List<Property Map>
    name String
    The name of this team.
    spaceId String
    The space associated with this team.
    teamId String
    The unique ID for this resource.
    userRoles List<Property Map>
    users List<String>
    A list of user IDs designated to be members of this team.

    Supporting Types

    TeamExternalSecurityGroup, TeamExternalSecurityGroupArgs

    DisplayIdAndName bool
    DisplayName string
    Id string
    The unique ID for this resource.
    DisplayIdAndName bool
    DisplayName string
    Id string
    The unique ID for this resource.
    displayIdAndName Boolean
    displayName String
    id String
    The unique ID for this resource.
    displayIdAndName boolean
    displayName string
    id string
    The unique ID for this resource.
    display_id_and_name bool
    display_name str
    id str
    The unique ID for this resource.
    displayIdAndName Boolean
    displayName String
    id String
    The unique ID for this resource.

    TeamUserRole, TeamUserRoleArgs

    SpaceId string
    UserRoleId string
    EnvironmentIds List<string>
    Id string
    The ID of this resource.
    ProjectGroupIds List<string>
    ProjectIds List<string>
    TeamId string
    TenantIds List<string>
    SpaceId string
    UserRoleId string
    EnvironmentIds []string
    Id string
    The ID of this resource.
    ProjectGroupIds []string
    ProjectIds []string
    TeamId string
    TenantIds []string
    spaceId String
    userRoleId String
    environmentIds List<String>
    id String
    The ID of this resource.
    projectGroupIds List<String>
    projectIds List<String>
    teamId String
    tenantIds List<String>
    spaceId string
    userRoleId string
    environmentIds string[]
    id string
    The ID of this resource.
    projectGroupIds string[]
    projectIds string[]
    teamId string
    tenantIds string[]
    space_id str
    user_role_id str
    environment_ids Sequence[str]
    id str
    The ID of this resource.
    project_group_ids Sequence[str]
    project_ids Sequence[str]
    team_id str
    tenant_ids Sequence[str]
    spaceId String
    userRoleId String
    environmentIds List<String>
    id String
    The ID of this resource.
    projectGroupIds List<String>
    projectIds List<String>
    teamId String
    tenantIds List<String>

    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