dbtcloud.getGroup

Explore with Pulumi AI

dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>

def get_group(group_id: Optional[int] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[int]] = 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: dbtcloud:index/getGroup:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

GroupId int: The ID of the group

GroupId int: The ID of the group

groupId Integer: The ID of the group

groupId number: The ID of the group

group_id int: The ID of the group

groupId Number: The ID of the group

getGroup Result

The following output properties are available:

AssignByDefault bool: Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
GroupId int: The ID of the group
GroupPermissions List<Pulumi.DbtCloud.Outputs.GetGroupGroupPermission>: Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
Id int: The ID of this resource
Name string: Group name
SsoMappingGroups List<string>: SSO mapping group names for this group

AssignByDefault bool: Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
GroupId int: The ID of the group
GroupPermissions []GetGroupGroupPermission: Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
Id int: The ID of this resource
Name string: Group name
SsoMappingGroups []string: SSO mapping group names for this group

assignByDefault Boolean: Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
groupId Integer: The ID of the group
groupPermissions List<GetGroupGroupPermission>: Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
id Integer: The ID of this resource
name String: Group name
ssoMappingGroups List<String>: SSO mapping group names for this group

assignByDefault boolean: Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
groupId number: The ID of the group
groupPermissions GetGroupGroupPermission[]: Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
id number: The ID of this resource
name string: Group name
ssoMappingGroups string[]: SSO mapping group names for this group

assign_by_default bool: Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
group_id int: The ID of the group
group_permissions Sequence[GetGroupGroupPermission]: Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
id int: The ID of this resource
name str: Group name
sso_mapping_groups Sequence[str]: SSO mapping group names for this group

assignByDefault Boolean: Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
groupId Number: The ID of the group
groupPermissions List<Property Map>: Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
id Number: The ID of this resource
name String: Group name
ssoMappingGroups List<String>: SSO mapping group names for this group

Supporting Types

GetGroupGroupPermission

AllProjects bool: Whether access should be provided for all projects or not.
PermissionSet string: Set of permissions to apply. The permissions allowed are the same as the ones for the dbtcloud.Group resource.
ProjectId int: Project ID to apply this permission to for this group.
WritableEnvironmentCategories List<string>: What types of environments to apply Write permissions to.

AllProjects bool: Whether access should be provided for all projects or not.
PermissionSet string: Set of permissions to apply. The permissions allowed are the same as the ones for the dbtcloud.Group resource.
ProjectId int: Project ID to apply this permission to for this group.
WritableEnvironmentCategories []string: What types of environments to apply Write permissions to.

allProjects Boolean: Whether access should be provided for all projects or not.
permissionSet String: Set of permissions to apply. The permissions allowed are the same as the ones for the dbtcloud.Group resource.
projectId Integer: Project ID to apply this permission to for this group.
writableEnvironmentCategories List<String>: What types of environments to apply Write permissions to.

allProjects boolean: Whether access should be provided for all projects or not.
permissionSet string: Set of permissions to apply. The permissions allowed are the same as the ones for the dbtcloud.Group resource.
projectId number: Project ID to apply this permission to for this group.
writableEnvironmentCategories string[]: What types of environments to apply Write permissions to.

all_projects bool: Whether access should be provided for all projects or not.
permission_set str: Set of permissions to apply. The permissions allowed are the same as the ones for the dbtcloud.Group resource.
project_id int: Project ID to apply this permission to for this group.
writable_environment_categories Sequence[str]: What types of environments to apply Write permissions to.

allProjects Boolean: Whether access should be provided for all projects or not.
permissionSet String: Set of permissions to apply. The permissions allowed are the same as the ones for the dbtcloud.Group resource.
projectId Number: Project ID to apply this permission to for this group.
writableEnvironmentCategories List<String>: What types of environments to apply Write permissions to.

Package Details

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

dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi

pulumi/pulumi-dbtcloud

dbtcloud.getGroup

On this page

On this page

Using getGroup

getGroup Result

Supporting Types

GetGroupGroupPermission

Package Details

On this page

On this page