1. Registry
  2. Packages
  3. DataRobot
  4. API Docs
  5. getGroup
Viewing docs for DataRobot v0.12.4
published on Wednesday, Sep 23, 2026 by DataRobot, Inc.
datarobot logo
Viewing docs for DataRobot v0.12.4
published on Wednesday, Sep 23, 2026 by DataRobot, Inc.

    Looks up a directory group by name and returns its ID, so that group memberships and shares can be expressed by name rather than by hardcoded ID.

    Names are matched in full and case sensitively, so the name must be given exactly as it appears in the identity provider. Results are scoped to the caller’s organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as datarobot from "@datarobot/pulumi-datarobot";
    
    const finance = datarobot.getGroup({
        name: "FinanceTeam",
    });
    export const financeGroupId = finance.then(finance => finance.id);
    
    import pulumi
    import pulumi_datarobot as datarobot
    
    finance = datarobot.get_group(name="FinanceTeam")
    pulumi.export("financeGroupId", finance.id)
    
    package main
    
    import (
    	"github.com/datarobot-community/pulumi-datarobot/sdk/go/datarobot"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		finance, err := datarobot.GetGroup(ctx, &datarobot.GetGroupArgs{
    			Name: "FinanceTeam",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("financeGroupId", finance.Id)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Datarobot = DataRobotPulumi.Datarobot;
    
    return await Deployment.RunAsync(() => 
    {
        var finance = Datarobot.GetGroup.Invoke(new()
        {
            Name = "FinanceTeam",
        });
    
        return new Dictionary<string, object?>
        {
            ["financeGroupId"] = finance.Apply(getGroupResult => getGroupResult.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.datarobot.DatarobotFunctions;
    import com.pulumi.datarobot.inputs.GetGroupArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 finance = DatarobotFunctions.getGroup(GetGroupArgs.builder()
                .name("FinanceTeam")
                .build());
    
            ctx.export("financeGroupId", finance.id());
        }
    }
    
    variables:
      finance:
        fn::invoke:
          function: datarobot:getGroup
          arguments:
            name: FinanceTeam
    outputs:
      financeGroupId: ${finance.id}
    
    pulumi {
      required_providers {
        datarobot = {
          source = "pulumi/datarobot"
        }
      }
    }
    
    data "datarobot_getgroup" "finance" {
      name = "FinanceTeam"
    }
    
    output "financeGroupId" {
      value = data.datarobot_getgroup.finance.id
    }
    

    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?: InvokeOutputOptions): Output<GetGroupResult>
    def get_group(name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetGroupResult
    def get_group_output(name: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetGroupResult]
    func GetGroup(ctx *Context, args *GetGroupArgs, opts ...InvokeOption) (*GetGroupResult, error)
    func GetGroupOutput(ctx *Context, args *GetGroupOutputArgs, opts ...InvokeOption) GetGroupResultOutput

    > Note: This function is named GetGroup 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 Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
    public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
    public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: datarobot:index/getGroup:getGroup
      arguments:
        # arguments dictionary
    data "datarobot_get_group" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    The name of the group, matched in full and case sensitively.
    Name string
    The name of the group, matched in full and case sensitively.
    name string
    The name of the group, matched in full and case sensitively.
    name String
    The name of the group, matched in full and case sensitively.
    name string
    The name of the group, matched in full and case sensitively.
    name str
    The name of the group, matched in full and case sensitively.
    name String
    The name of the group, matched in full and case sensitively.

    getGroup Result

    The following output properties are available:

    Description string
    The description of the group, or null if none is set.
    Id string
    The ID of the group.
    Name string
    The name of the group, matched in full and case sensitively.
    ProvisioningSource string
    How the group is provisioned: scim when synced from an external identity provider, local when created in DataRobot.
    Description string
    The description of the group, or null if none is set.
    Id string
    The ID of the group.
    Name string
    The name of the group, matched in full and case sensitively.
    ProvisioningSource string
    How the group is provisioned: scim when synced from an external identity provider, local when created in DataRobot.
    description string
    The description of the group, or null if none is set.
    id string
    The ID of the group.
    name string
    The name of the group, matched in full and case sensitively.
    provisioning_source string
    How the group is provisioned: scim when synced from an external identity provider, local when created in DataRobot.
    description String
    The description of the group, or null if none is set.
    id String
    The ID of the group.
    name String
    The name of the group, matched in full and case sensitively.
    provisioningSource String
    How the group is provisioned: scim when synced from an external identity provider, local when created in DataRobot.
    description string
    The description of the group, or null if none is set.
    id string
    The ID of the group.
    name string
    The name of the group, matched in full and case sensitively.
    provisioningSource string
    How the group is provisioned: scim when synced from an external identity provider, local when created in DataRobot.
    description str
    The description of the group, or null if none is set.
    id str
    The ID of the group.
    name str
    The name of the group, matched in full and case sensitively.
    provisioning_source str
    How the group is provisioned: scim when synced from an external identity provider, local when created in DataRobot.
    description String
    The description of the group, or null if none is set.
    id String
    The ID of the group.
    name String
    The name of the group, matched in full and case sensitively.
    provisioningSource String
    How the group is provisioned: scim when synced from an external identity provider, local when created in DataRobot.

    Package Details

    Repository
    datarobot datarobot-community/pulumi-datarobot
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datarobot Terraform Provider.
    datarobot logo
    Viewing docs for DataRobot v0.12.4
    published on Wednesday, Sep 23, 2026 by DataRobot, Inc.

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial