getGroups

Use this data source to get list of the Cloud Identity Groups under a customer or namespace.

https://cloud.google.com/identity/docs/concepts/overview#groups

Example Usage

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var groups = Output.Create(Gcp.CloudIdentity.GetGroups.InvokeAsync(new Gcp.CloudIdentity.GetGroupsArgs
        {
            Parent = "customers/A01b123xz",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/cloudidentity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudidentity.GetGroups(ctx, &cloudidentity.GetGroupsArgs{
			Parent: "customers/A01b123xz",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_gcp as gcp

groups = gcp.cloudidentity.get_groups(parent="customers/A01b123xz")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const groups = pulumi.output(gcp.cloudidentity.getGroups({
    parent: "customers/A01b123xz",
}, { async: true }));

Using getGroups

function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
def get_groups(parent: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)

Note: This function is named GetGroups in the Go SDK.

public static class GetGroups {
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Parent string
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
Parent string
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
parent string
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
parent str
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.

getGroups Result

The following output properties are available:

Groups List<GetGroupsGroup>
The list of groups under the provided customer or namespace. Structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Parent string
Groups []GetGroupsGroup
The list of groups under the provided customer or namespace. Structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Parent string
groups GetGroupsGroup[]
The list of groups under the provided customer or namespace. Structure is documented below.
id string
The provider-assigned unique ID for this managed resource.
parent string
groups Sequence[GetGroupsGroup]
The list of groups under the provided customer or namespace. Structure is documented below.
id str
The provider-assigned unique ID for this managed resource.
parent str

Supporting Types

GetGroupsGroup

CreateTime string
Description string
DisplayName string
GroupKeys List<GetGroupsGroupGroupKey>
InitialGroupConfig string
Labels Dictionary<string, string>
Name string
Parent string
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
UpdateTime string
CreateTime string
Description string
DisplayName string
GroupKeys []GetGroupsGroupGroupKey
InitialGroupConfig string
Labels map[string]string
Name string
Parent string
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
UpdateTime string
createTime string
description string
displayName string
groupKeys GetGroupsGroupGroupKey[]
initialGroupConfig string
labels {[key: string]: string}
name string
parent string
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
updateTime string
create_time str
description str
display_name str
group_keys Sequence[GetGroupsGroupGroupKey]
initial_group_config str
labels Mapping[str, str]
name str
parent str
The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.
update_time str

GetGroupsGroupGroupKey

Id string
Namespace string
Id string
Namespace string
id string
namespace string
id str
namespace str

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.