dbtcloud.getGroups

Explore with Pulumi AI

dbt Cloud v1.1.1 published on Wednesday, Sep 17, 2025 by Pulumi

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(name: Optional[str] = None,
               name_contains: Optional[str] = None,
               state: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(name: Optional[pulumi.Input[str]] = None,
               name_contains: Optional[pulumi.Input[str]] = None,
               state: 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: dbtcloud:index/getGroups:getGroups
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Filter groups by exact name match
NameContains string: Filter groups by partial name match (case insensitive)
State string: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

Name string: Filter groups by exact name match
NameContains string: Filter groups by partial name match (case insensitive)
State string: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

name String: Filter groups by exact name match
nameContains String: Filter groups by partial name match (case insensitive)
state String: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

name string: Filter groups by exact name match
nameContains string: Filter groups by partial name match (case insensitive)
state string: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

name str: Filter groups by exact name match
name_contains str: Filter groups by partial name match (case insensitive)
state str: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

name String: Filter groups by exact name match
nameContains String: Filter groups by partial name match (case insensitive)
state String: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

getGroups Result

The following output properties are available:

Groups List<Pulumi.DbtCloud.Outputs.GetGroupsGroup>: Set of groups in the account
Id string: The provider-assigned unique ID for this managed resource.
Name string: Filter groups by exact name match
NameContains string: Filter groups by partial name match (case insensitive)
State string: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

Groups []GetGroupsGroup: Set of groups in the account
Id string: The provider-assigned unique ID for this managed resource.
Name string: Filter groups by exact name match
NameContains string: Filter groups by partial name match (case insensitive)
State string: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

groups List<GetGroupsGroup>: Set of groups in the account
id String: The provider-assigned unique ID for this managed resource.
name String: Filter groups by exact name match
nameContains String: Filter groups by partial name match (case insensitive)
state String: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

groups GetGroupsGroup[]: Set of groups in the account
id string: The provider-assigned unique ID for this managed resource.
name string: Filter groups by exact name match
nameContains string: Filter groups by partial name match (case insensitive)
state string: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

groups Sequence[GetGroupsGroup]: Set of groups in the account
id str: The provider-assigned unique ID for this managed resource.
name str: Filter groups by exact name match
name_contains str: Filter groups by partial name match (case insensitive)
state str: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

groups List<Property Map>: Set of groups in the account
id String: The provider-assigned unique ID for this managed resource.
name String: Filter groups by exact name match
nameContains String: Filter groups by partial name match (case insensitive)
state String: Filter groups by state. Accepts both string and integer formats: 'active'/'1' for active resources, 'deleted'/'2' for deleted resources, 'all' for all resources. Defaults to active groups only if not specified.

Supporting Types

GetGroupsGroup

AssignByDefault bool: Whether the group will be assigned by default to users
Id int: The ID of the group
Name string: Group name
ScimManaged bool: Whether the group is managed by SCIM
SsoMappingGroups List<string>: SSO mapping group names for this group
State int: The state of the group (1=active, 2=deleted)

AssignByDefault bool: Whether the group will be assigned by default to users
Id int: The ID of the group
Name string: Group name
ScimManaged bool: Whether the group is managed by SCIM
SsoMappingGroups []string: SSO mapping group names for this group
State int: The state of the group (1=active, 2=deleted)

assignByDefault Boolean: Whether the group will be assigned by default to users
id Integer: The ID of the group
name String: Group name
scimManaged Boolean: Whether the group is managed by SCIM
ssoMappingGroups List<String>: SSO mapping group names for this group
state Integer: The state of the group (1=active, 2=deleted)

assignByDefault boolean: Whether the group will be assigned by default to users
id number: The ID of the group
name string: Group name
scimManaged boolean: Whether the group is managed by SCIM
ssoMappingGroups string[]: SSO mapping group names for this group
state number: The state of the group (1=active, 2=deleted)

assign_by_default bool: Whether the group will be assigned by default to users
id int: The ID of the group
name str: Group name
scim_managed bool: Whether the group is managed by SCIM
sso_mapping_groups Sequence[str]: SSO mapping group names for this group
state int: The state of the group (1=active, 2=deleted)

assignByDefault Boolean: Whether the group will be assigned by default to users
id Number: The ID of the group
name String: Group name
scimManaged Boolean: Whether the group is managed by SCIM
ssoMappingGroups List<String>: SSO mapping group names for this group
state Number: The state of the group (1=active, 2=deleted)

Package Details

Repository: dbtcloud pulumi/pulumi-dbtcloud
License: Apache-2.0
Notes: This Pulumi package is based on the dbtcloud Terraform Provider.

dbt Cloud v1.1.1 published on Wednesday, Sep 17, 2025 by Pulumi

pulumi/pulumi-dbtcloud

dbtcloud.getGroups

On this page

On this page

Using getGroups

getGroups Result

Supporting Types

GetGroupsGroup

Package Details

On this page

On this page