1. Packages
  2. Wavefront Provider
  3. API Docs
  4. getUserGroups
wavefront 5.1.0 published on Wednesday, Jan 21, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-wavefront

wavefront.getUserGroups

wavefront logo
wavefront 5.1.0 published on Wednesday, Jan 21, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-wavefront

    Use this data source to get all User Groups in Wavefront.

    Example Usage

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

// Get all user groups
const groups = wavefront.getUserGroups({
    limit: 10,
    offset: 0,
});

    import pulumi
import pulumi_wavefront as wavefront

# Get all user groups
groups = wavefront.get_user_groups(limit=10,
    offset=0)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get all user groups
		_, err := wavefront.GetUserGroups(ctx, &wavefront.GetUserGroupsArgs{
			Limit:  pulumi.Float64Ref(10),
			Offset: pulumi.Float64Ref(0),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Get all user groups
    var groups = Wavefront.GetUserGroups.Invoke(new()
    {
        Limit = 10,
        Offset = 0,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.WavefrontFunctions;
import com.pulumi.wavefront.inputs.GetUserGroupsArgs;
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) {
        // Get all user groups
        final var groups = WavefrontFunctions.getUserGroups(GetUserGroupsArgs.builder()
            .limit(10)
            .offset(0)
            .build());

    }
}

    variables:
  # Get all user groups
  groups:
    fn::invoke:
      function: wavefront:getUserGroups
      arguments:
        limit: 10
        offset: 0

    Using getUserGroups

    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 getUserGroups(args: GetUserGroupsArgs, opts?: InvokeOptions): Promise<GetUserGroupsResult>
function getUserGroupsOutput(args: GetUserGroupsOutputArgs, opts?: InvokeOptions): Output<GetUserGroupsResult>
    def get_user_groups(id: Optional[str] = None,
                    limit: Optional[float] = None,
                    offset: Optional[float] = None,
                    opts: Optional[InvokeOptions] = None) -> GetUserGroupsResult
def get_user_groups_output(id: Optional[pulumi.Input[str]] = None,
                    limit: Optional[pulumi.Input[float]] = None,
                    offset: Optional[pulumi.Input[float]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupsResult]
    func GetUserGroups(ctx *Context, args *GetUserGroupsArgs, opts ...InvokeOption) (*GetUserGroupsResult, error)
func GetUserGroupsOutput(ctx *Context, args *GetUserGroupsOutputArgs, opts ...InvokeOption) GetUserGroupsResultOutput

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

    public static class GetUserGroups 
{
    public static Task<GetUserGroupsResult> InvokeAsync(GetUserGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetUserGroupsResult> Invoke(GetUserGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)
public static Output<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: wavefront:index/getUserGroups:getUserGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The group ID.
    Limit double
    Limit is the maximum number of results to be returned. Defaults to 100.
    Offset double
    Offset is the offset from the first result to be returned. Defaults to 0.
    Id string
    The group ID.
    Limit float64
    Limit is the maximum number of results to be returned. Defaults to 100.
    Offset float64
    Offset is the offset from the first result to be returned. Defaults to 0.
    id String
    The group ID.
    limit Double
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset Double
    Offset is the offset from the first result to be returned. Defaults to 0.
    id string
    The group ID.
    limit number
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset number
    Offset is the offset from the first result to be returned. Defaults to 0.
    id str
    The group ID.
    limit float
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset float
    Offset is the offset from the first result to be returned. Defaults to 0.
    id String
    The group ID.
    limit Number
    Limit is the maximum number of results to be returned. Defaults to 100.
    offset Number
    Offset is the offset from the first result to be returned. Defaults to 0.

    getUserGroups Result

    The following output properties are available:

    Id string
    The group ID.
    UserGroups List<GetUserGroupsUserGroup>
    List of user groups.
    Limit double
    Offset double
    Id string
    The group ID.
    UserGroups []GetUserGroupsUserGroup
    List of user groups.
    Limit float64
    Offset float64
    id String
    The group ID.
    userGroups List<GetUserGroupsUserGroup>
    List of user groups.
    limit Double
    offset Double
    id string
    The group ID.
    userGroups GetUserGroupsUserGroup[]
    List of user groups.
    limit number
    offset number
    id str
    The group ID.
    user_groups Sequence[GetUserGroupsUserGroup]
    List of user groups.
    limit float
    offset float
    id String
    The group ID.
    userGroups List<Property Map>
    List of user groups.
    limit Number
    offset Number

    Supporting Types

    GetUserGroupsUserGroup

    Description string
    The group description.
    Id string
    The group ID.
    Name string
    The group name.
    Roles List<string>
    List of roles associated with the group.
    Users List<string>
    List of users assigned to the group.
    Description string
    The group description.
    Id string
    The group ID.
    Name string
    The group name.
    Roles []string
    List of roles associated with the group.
    Users []string
    List of users assigned to the group.
    description String
    The group description.
    id String
    The group ID.
    name String
    The group name.
    roles List<String>
    List of roles associated with the group.
    users List<String>
    List of users assigned to the group.
    description string
    The group description.
    id string
    The group ID.
    name string
    The group name.
    roles string[]
    List of roles associated with the group.
    users string[]
    List of users assigned to the group.
    description str
    The group description.
    id str
    The group ID.
    name str
    The group name.
    roles Sequence[str]
    List of roles associated with the group.
    users Sequence[str]
    List of users assigned to the group.
    description String
    The group description.
    id String
    The group ID.
    name String
    The group name.
    roles List<String>
    List of roles associated with the group.
    users List<String>
    List of users assigned to the group.

    Package Details

    Repository
    Wavefront vmware/terraform-provider-wavefront
    License
    Notes
    This Pulumi package is based on the wavefront Terraform Provider.
    wavefront logo
    wavefront 5.1.0 published on Wednesday, Jan 21, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-wavefront
      Meet Neo: Your AI Platform Teammate