1. Packages
  2. StrongDM
  3. API Docs
  4. getGroup
StrongDM v1.32.0 published on Monday, Oct 13, 2025 by Piers Karsenbarg

sdm.getGroup

Deploy with Pulumi
sdm logo
StrongDM v1.32.0 published on Monday, Oct 13, 2025 by Piers Karsenbarg

    A Group is a named set of principals.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as sdm from "@pierskarsenbarg/sdm";
    
    const securityTeam = sdm.getGroup({
        name: "Security Team",
    });
    const administrators = sdm.getGroup({
        id: "group-1234567890abcdef",
    });
    const adminTeams = sdm.getGroup({
        tags: {
            admin: "true",
        },
    });
    
    import pulumi
    import pulumi_sdm as sdm
    
    security_team = sdm.get_group(name="Security Team")
    administrators = sdm.get_group(id="group-1234567890abcdef")
    admin_teams = sdm.get_group(tags={
        "admin": "true",
    })
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-sdm/sdk/go/sdm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sdm.LookupGroup(ctx, &sdm.LookupGroupArgs{
    			Name: pulumi.StringRef("Security Team"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = sdm.LookupGroup(ctx, &sdm.LookupGroupArgs{
    			Id: pulumi.StringRef("group-1234567890abcdef"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = sdm.LookupGroup(ctx, &sdm.LookupGroupArgs{
    			Tags: map[string]interface{}{
    				"admin": "true",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Sdm = Pulumi.Sdm;
    
    return await Deployment.RunAsync(() => 
    {
        var securityTeam = Sdm.GetGroup.Invoke(new()
        {
            Name = "Security Team",
        });
    
        var administrators = Sdm.GetGroup.Invoke(new()
        {
            Id = "group-1234567890abcdef",
        });
    
        var adminTeams = Sdm.GetGroup.Invoke(new()
        {
            Tags = 
            {
                { "admin", "true" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdm.SdmFunctions;
    import com.pulumi.sdm.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 securityTeam = SdmFunctions.getGroup(GetGroupArgs.builder()
                .name("Security Team")
                .build());
    
            final var administrators = SdmFunctions.getGroup(GetGroupArgs.builder()
                .id("group-1234567890abcdef")
                .build());
    
            final var adminTeams = SdmFunctions.getGroup(GetGroupArgs.builder()
                .tags(Map.of("admin", "true"))
                .build());
    
        }
    }
    
    variables:
      securityTeam:
        fn::invoke:
          function: sdm:getGroup
          arguments:
            name: Security Team
      administrators:
        fn::invoke:
          function: sdm:getGroup
          arguments:
            id: group-1234567890abcdef
      adminTeams:
        fn::invoke:
          function: sdm:getGroup
          arguments:
            tags:
              admin: 'true'
    

    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(description: Optional[str] = None,
                  id: Optional[str] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetGroupResult
    def get_group_output(description: Optional[pulumi.Input[str]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, 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: sdm:index/getGroup:getGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    Description of the Group.
    Id string
    Unique identifier of the Group.
    Name string
    Unique human-readable name of the Group.
    Tags Dictionary<string, string>
    Tags is a map of key/value pairs that can be attached to a Group.
    Description string
    Description of the Group.
    Id string
    Unique identifier of the Group.
    Name string
    Unique human-readable name of the Group.
    Tags map[string]string
    Tags is a map of key/value pairs that can be attached to a Group.
    description String
    Description of the Group.
    id String
    Unique identifier of the Group.
    name String
    Unique human-readable name of the Group.
    tags Map<String,String>
    Tags is a map of key/value pairs that can be attached to a Group.
    description string
    Description of the Group.
    id string
    Unique identifier of the Group.
    name string
    Unique human-readable name of the Group.
    tags {[key: string]: string}
    Tags is a map of key/value pairs that can be attached to a Group.
    description str
    Description of the Group.
    id str
    Unique identifier of the Group.
    name str
    Unique human-readable name of the Group.
    tags Mapping[str, str]
    Tags is a map of key/value pairs that can be attached to a Group.
    description String
    Description of the Group.
    id String
    Unique identifier of the Group.
    name String
    Unique human-readable name of the Group.
    tags Map<String>
    Tags is a map of key/value pairs that can be attached to a Group.

    getGroup Result

    The following output properties are available:

    Groups List<PiersKarsenbarg.Sdm.Outputs.GetGroupGroup>
    A list where each element has the following attributes:
    Ids List<string>
    a list of strings of ids of data sources that match the given arguments.
    Source string
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    Description string
    Description of the Group.
    Id string
    Unique identifier of the Group.
    Name string
    Unique human-readable name of the Group.
    Tags Dictionary<string, string>
    Tags is a map of key/value pairs that can be attached to a Group.
    Groups []GetGroupGroup
    A list where each element has the following attributes:
    Ids []string
    a list of strings of ids of data sources that match the given arguments.
    Source string
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    Description string
    Description of the Group.
    Id string
    Unique identifier of the Group.
    Name string
    Unique human-readable name of the Group.
    Tags map[string]string
    Tags is a map of key/value pairs that can be attached to a Group.
    groups List<GetGroupGroup>
    A list where each element has the following attributes:
    ids List<String>
    a list of strings of ids of data sources that match the given arguments.
    source String
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description String
    Description of the Group.
    id String
    Unique identifier of the Group.
    name String
    Unique human-readable name of the Group.
    tags Map<String,String>
    Tags is a map of key/value pairs that can be attached to a Group.
    groups GetGroupGroup[]
    A list where each element has the following attributes:
    ids string[]
    a list of strings of ids of data sources that match the given arguments.
    source string
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description string
    Description of the Group.
    id string
    Unique identifier of the Group.
    name string
    Unique human-readable name of the Group.
    tags {[key: string]: string}
    Tags is a map of key/value pairs that can be attached to a Group.
    groups Sequence[GetGroupGroup]
    A list where each element has the following attributes:
    ids Sequence[str]
    a list of strings of ids of data sources that match the given arguments.
    source str
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description str
    Description of the Group.
    id str
    Unique identifier of the Group.
    name str
    Unique human-readable name of the Group.
    tags Mapping[str, str]
    Tags is a map of key/value pairs that can be attached to a Group.
    groups List<Property Map>
    A list where each element has the following attributes:
    ids List<String>
    a list of strings of ids of data sources that match the given arguments.
    source String
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description String
    Description of the Group.
    id String
    Unique identifier of the Group.
    name String
    Unique human-readable name of the Group.
    tags Map<String>
    Tags is a map of key/value pairs that can be attached to a Group.

    Supporting Types

    GetGroupGroup

    Source string
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    Description string
    Description of the Group.
    Id string
    Unique identifier of the Group.
    Name string
    Unique human-readable name of the Group.
    Tags Dictionary<string, string>
    Tags is a map of key/value pairs that can be attached to a Group.
    Source string
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    Description string
    Description of the Group.
    Id string
    Unique identifier of the Group.
    Name string
    Unique human-readable name of the Group.
    Tags map[string]string
    Tags is a map of key/value pairs that can be attached to a Group.
    source String
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description String
    Description of the Group.
    id String
    Unique identifier of the Group.
    name String
    Unique human-readable name of the Group.
    tags Map<String,String>
    Tags is a map of key/value pairs that can be attached to a Group.
    source string
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description string
    Description of the Group.
    id string
    Unique identifier of the Group.
    name string
    Unique human-readable name of the Group.
    tags {[key: string]: string}
    Tags is a map of key/value pairs that can be attached to a Group.
    source str
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description str
    Description of the Group.
    id str
    Unique identifier of the Group.
    name str
    Unique human-readable name of the Group.
    tags Mapping[str, str]
    Tags is a map of key/value pairs that can be attached to a Group.
    source String
    Source is a read only field for what service manages this group, e.g. StrongDM, Okta, Azure.
    description String
    Description of the Group.
    id String
    Unique identifier of the Group.
    name String
    Unique human-readable name of the Group.
    tags Map<String>
    Tags is a map of key/value pairs that can be attached to a Group.

    Package Details

    Repository
    sdm pierskarsenbarg/pulumi-sdm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdm Terraform Provider.
    sdm logo
    StrongDM v1.32.0 published on Monday, Oct 13, 2025 by Piers Karsenbarg
      Meet Neo: Your AI Platform Teammate