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

bitbucket.getGroup

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 a group.

    Example Usage

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

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

    import pulumi
import pulumi_bitbucket as bitbucket

example = bitbucket.get_group(slug="example",
    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.LookupGroup(ctx, &bitbucket.LookupGroupArgs{
			Slug:      "example",
			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.GetGroup.Invoke(new()
    {
        Slug = "example",
        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.GetGroupArgs;
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.getGroup(GetGroupArgs.builder()
            .slug("example")
            .workspace("example")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: bitbucket:getGroup
      arguments:
        slug: example
        workspace: example

    Using getGroup

    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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
    def get_group(id: Optional[str] = None,
              slug: Optional[str] = None,
              workspace: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(id: Optional[pulumi.Input[str]] = None,
              slug: Optional[pulumi.Input[str]] = None,
              workspace: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
    func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

    public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Slug string
    The group's slug.
    Workspace string
    The UUID that bitbucket groups to connect a group to various objects
    Id string
    Slug string
    The group's slug.
    Workspace string
    The UUID that bitbucket groups to connect a group to various objects
    Id string
    slug String
    The group's slug.
    workspace String
    The UUID that bitbucket groups to connect a group to various objects
    id String
    slug string
    The group's slug.
    workspace string
    The UUID that bitbucket groups to connect a group to various objects
    id string
    slug str
    The group's slug.
    workspace str
    The UUID that bitbucket groups to connect a group to various objects
    id str
    slug String
    The group's slug.
    workspace String
    The UUID that bitbucket groups to connect a group to various objects
    id String

    getGroup Result

    The following output properties are available:

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

    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.