1. Packages
  2. Bitbucket Provider
  3. API Docs
  4. getGroups
Viewing docs for bitbucket 2.50.0
published on Wednesday, Oct 8, 2025 by drfaust92
Schema (JSON)
drfaust92/terraform-provider-bitbucket

bitbucket.getGroups

bitbucket logo
Viewing docs for bitbucket 2.50.0
published on Wednesday, Oct 8, 2025 by drfaust92
Schema (JSON)
drfaust92/terraform-provider-bitbucket

    Provides a way to fetch data of groups in a workspace.

    Example Usage

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

const example = bitbucket.getGroups({
    workspace: "example",
});

    import pulumi
import pulumi_bitbucket as bitbucket

example = bitbucket.get_groups(workspace="example")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bitbucket.GetGroups(ctx, &bitbucket.GetGroupsArgs{
			Workspace: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Bitbucket.GetGroups.Invoke(new()
    {
        Workspace = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.bitbucket.BitbucketFunctions;
import com.pulumi.bitbucket.inputs.GetGroupsArgs;
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) {
        final var example = BitbucketFunctions.getGroups(GetGroupsArgs.builder()
            .workspace("example")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: bitbucket:getGroups
      arguments:
        workspace: example

    Using getGroups

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>
    def get_groups(id: Optional[str] = None,
               workspace: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(id: Optional[pulumi.Input[str]] = None,
               workspace: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
    func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

    > Note: This function is named GetGroups in the Go SDK.

    public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
public static Output<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: bitbucket:index/getGroups:getGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Workspace string
    The UUID that bitbucket groupss to connect a groups to various objects
    Id string
    Workspace string
    The UUID that bitbucket groupss to connect a groups to various objects
    Id string
    workspace String
    The UUID that bitbucket groupss to connect a groups to various objects
    id String
    workspace string
    The UUID that bitbucket groupss to connect a groups to various objects
    id string
    workspace str
    The UUID that bitbucket groupss to connect a groups to various objects
    id str
    workspace String
    The UUID that bitbucket groupss to connect a groups to various objects
    id String

    getGroups Result

    The following output properties are available:

    Groups List<GetGroupsGroup>
    The list of groups in the workspace. See Group below for structure of each element
    Id string
    Workspace string
    Groups []GetGroupsGroup
    The list of groups in the workspace. See Group below for structure of each element
    Id string
    Workspace string
    groups List<GetGroupsGroup>
    The list of groups in the workspace. See Group below for structure of each element
    id String
    workspace String
    groups GetGroupsGroup[]
    The list of groups in the workspace. See Group below for structure of each element
    id string
    workspace string
    groups Sequence[GetGroupsGroup]
    The list of groups in the workspace. See Group below for structure of each element
    id str
    workspace str
    groups List<Property Map>
    The list of groups in the workspace. See Group below for structure of each element
    id String
    workspace String

    Supporting Types

    GetGroupsGroup

    AutoAdd bool
    Whether to automatically add users the groups
    EmailForwardingDisabled bool
    Whether to disable email forwarding for group.
    Name string
    The name of the groups.
    Permission string
    One of read, write, and admin.
    Slug string
    The groups's slug.
    AutoAdd bool
    Whether to automatically add users the groups
    EmailForwardingDisabled bool
    Whether to disable email forwarding for group.
    Name string
    The name of the groups.
    Permission string
    One of read, write, and admin.
    Slug string
    The groups's slug.
    autoAdd Boolean
    Whether to automatically add users the groups
    emailForwardingDisabled Boolean
    Whether to disable email forwarding for group.
    name String
    The name of the groups.
    permission String
    One of read, write, and admin.
    slug String
    The groups's slug.
    autoAdd boolean
    Whether to automatically add users the groups
    emailForwardingDisabled boolean
    Whether to disable email forwarding for group.
    name string
    The name of the groups.
    permission string
    One of read, write, and admin.
    slug string
    The groups's slug.
    auto_add bool
    Whether to automatically add users the groups
    email_forwarding_disabled bool
    Whether to disable email forwarding for group.
    name str
    The name of the groups.
    permission str
    One of read, write, and admin.
    slug str
    The groups's slug.
    autoAdd Boolean
    Whether to automatically add users the groups
    emailForwardingDisabled Boolean
    Whether to disable email forwarding for group.
    name String
    The name of the groups.
    permission String
    One of read, write, and admin.
    slug String
    The groups's slug.

    Package Details

    Repository
    bitbucket drfaust92/terraform-provider-bitbucket
    License
    Notes
    This Pulumi package is based on the bitbucket Terraform Provider.
    bitbucket logo
    Viewing docs for bitbucket 2.50.0
    published on Wednesday, Oct 8, 2025 by drfaust92
    Schema (JSON)
    drfaust92/terraform-provider-bitbucket
      Try Pulumi Cloud free. Your team will thank you.