Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. cloudidentity
  5. Group
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.cloudidentity.Group

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

A Cloud Identity resource representing a Group.

To get more information about Group, see:

Warning: If you are using User ADCs (Application Default Credentials) with this resource, you must specify a billing_project and set user_project_override to true in the provider configuration. Otherwise the Cloud Identity API will return a 403 error. Your account must have the serviceusage.services.use permission on the billing_project you defined.

Example Usage

Cloud Identity Groups Basic

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

const cloudIdentityGroupBasic = new gcp.cloudidentity.Group("cloud_identity_group_basic", {
    displayName: "my-identity-group",
    initialGroupConfig: "WITH_INITIAL_OWNER",
    parent: "customers/A01b123xz",
    groupKey: {
        id: "my-identity-group@example.com",
    },
    labels: {
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

cloud_identity_group_basic = gcp.cloudidentity.Group("cloud_identity_group_basic",
    display_name="my-identity-group",
    initial_group_config="WITH_INITIAL_OWNER",
    parent="customers/A01b123xz",
    group_key={
        "id": "my-identity-group@example.com",
    },
    labels={
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudidentity.NewGroup(ctx, "cloud_identity_group_basic", &cloudidentity.GroupArgs{
			DisplayName:        pulumi.String("my-identity-group"),
			InitialGroupConfig: pulumi.String("WITH_INITIAL_OWNER"),
			Parent:             pulumi.String("customers/A01b123xz"),
			GroupKey: &cloudidentity.GroupGroupKeyArgs{
				Id: pulumi.String("my-identity-group@example.com"),
			},
			Labels: pulumi.StringMap{
				"cloudidentity.googleapis.com/groups.discussion_forum": pulumi.String(""),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var cloudIdentityGroupBasic = new Gcp.CloudIdentity.Group("cloud_identity_group_basic", new()
    {
        DisplayName = "my-identity-group",
        InitialGroupConfig = "WITH_INITIAL_OWNER",
        Parent = "customers/A01b123xz",
        GroupKey = new Gcp.CloudIdentity.Inputs.GroupGroupKeyArgs
        {
            Id = "my-identity-group@example.com",
        },
        Labels = 
        {
            { "cloudidentity.googleapis.com/groups.discussion_forum", "" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudidentity.Group;
import com.pulumi.gcp.cloudidentity.GroupArgs;
import com.pulumi.gcp.cloudidentity.inputs.GroupGroupKeyArgs;
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) {
        var cloudIdentityGroupBasic = new Group("cloudIdentityGroupBasic", GroupArgs.builder()
            .displayName("my-identity-group")
            .initialGroupConfig("WITH_INITIAL_OWNER")
            .parent("customers/A01b123xz")
            .groupKey(GroupGroupKeyArgs.builder()
                .id("my-identity-group@example.com")
                .build())
            .labels(Map.of("cloudidentity.googleapis.com/groups.discussion_forum", ""))
            .build());

    }
}
Copy
resources:
  cloudIdentityGroupBasic:
    type: gcp:cloudidentity:Group
    name: cloud_identity_group_basic
    properties:
      displayName: my-identity-group
      initialGroupConfig: WITH_INITIAL_OWNER
      parent: customers/A01b123xz
      groupKey:
        id: my-identity-group@example.com
      labels:
        cloudidentity.googleapis.com/groups.discussion_forum: ""
Copy

Create Group Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_key: Optional[GroupGroupKeyArgs] = None,
          labels: Optional[Mapping[str, str]] = None,
          parent: Optional[str] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None,
          initial_group_config: Optional[str] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: gcp:cloudidentity:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var groupResource = new Gcp.CloudIdentity.Group("groupResource", new()
{
    GroupKey = new Gcp.CloudIdentity.Inputs.GroupGroupKeyArgs
    {
        Id = "string",
        Namespace = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Parent = "string",
    Description = "string",
    DisplayName = "string",
    InitialGroupConfig = "string",
});
Copy
example, err := cloudidentity.NewGroup(ctx, "groupResource", &cloudidentity.GroupArgs{
	GroupKey: &cloudidentity.GroupGroupKeyArgs{
		Id:        pulumi.String("string"),
		Namespace: pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Parent:             pulumi.String("string"),
	Description:        pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	InitialGroupConfig: pulumi.String("string"),
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .groupKey(GroupGroupKeyArgs.builder()
        .id("string")
        .namespace("string")
        .build())
    .labels(Map.of("string", "string"))
    .parent("string")
    .description("string")
    .displayName("string")
    .initialGroupConfig("string")
    .build());
Copy
group_resource = gcp.cloudidentity.Group("groupResource",
    group_key={
        "id": "string",
        "namespace": "string",
    },
    labels={
        "string": "string",
    },
    parent="string",
    description="string",
    display_name="string",
    initial_group_config="string")
Copy
const groupResource = new gcp.cloudidentity.Group("groupResource", {
    groupKey: {
        id: "string",
        namespace: "string",
    },
    labels: {
        string: "string",
    },
    parent: "string",
    description: "string",
    displayName: "string",
    initialGroupConfig: "string",
});
Copy
type: gcp:cloudidentity:Group
properties:
    description: string
    displayName: string
    groupKey:
        id: string
        namespace: string
    initialGroupConfig: string
    labels:
        string: string
    parent: string
Copy

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Group resource accepts the following input properties:

GroupKey
This property is required.
Changes to this property will trigger replacement.
GroupGroupKey
EntityKey of the Group. Structure is documented below.
Labels This property is required. Dictionary<string, string>
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
Parent
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
Description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string
The display name of the Group.
InitialGroupConfig Changes to this property will trigger replacement. string
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
GroupKey
This property is required.
Changes to this property will trigger replacement.
GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
Labels This property is required. map[string]string
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
Parent
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
Description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string
The display name of the Group.
InitialGroupConfig Changes to this property will trigger replacement. string
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
groupKey
This property is required.
Changes to this property will trigger replacement.
GroupGroupKey
EntityKey of the Group. Structure is documented below.
labels This property is required. Map<String,String>
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
parent
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
description String
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName String
The display name of the Group.
initialGroupConfig Changes to this property will trigger replacement. String
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
groupKey
This property is required.
Changes to this property will trigger replacement.
GroupGroupKey
EntityKey of the Group. Structure is documented below.
labels This property is required. {[key: string]: string}
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
parent
This property is required.
Changes to this property will trigger replacement.
string
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName string
The display name of the Group.
initialGroupConfig Changes to this property will trigger replacement. string
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
group_key
This property is required.
Changes to this property will trigger replacement.
GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
labels This property is required. Mapping[str, str]
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
parent
This property is required.
Changes to this property will trigger replacement.
str
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
description str
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
display_name str
The display name of the Group.
initial_group_config Changes to this property will trigger replacement. str
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
groupKey
This property is required.
Changes to this property will trigger replacement.
Property Map
EntityKey of the Group. Structure is documented below.
labels This property is required. Map<String>
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
parent
This property is required.
Changes to this property will trigger replacement.
String
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
description String
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName String
The display name of the Group.
initialGroupConfig Changes to this property will trigger replacement. String
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

AdditionalGroupKeys List<GroupAdditionalGroupKey>
Additional group keys associated with the Group Structure is documented below.
CreateTime string
The time when the Group was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
UpdateTime string
The time when the Group was last updated.
AdditionalGroupKeys []GroupAdditionalGroupKey
Additional group keys associated with the Group Structure is documented below.
CreateTime string
The time when the Group was created.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
UpdateTime string
The time when the Group was last updated.
additionalGroupKeys List<GroupAdditionalGroupKey>
Additional group keys associated with the Group Structure is documented below.
createTime String
The time when the Group was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
updateTime String
The time when the Group was last updated.
additionalGroupKeys GroupAdditionalGroupKey[]
Additional group keys associated with the Group Structure is documented below.
createTime string
The time when the Group was created.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
updateTime string
The time when the Group was last updated.
additional_group_keys Sequence[GroupAdditionalGroupKey]
Additional group keys associated with the Group Structure is documented below.
create_time str
The time when the Group was created.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
update_time str
The time when the Group was last updated.
additionalGroupKeys List<Property Map>
Additional group keys associated with the Group Structure is documented below.
createTime String
The time when the Group was created.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
updateTime String
The time when the Group was last updated.

Look up Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_group_keys: Optional[Sequence[GroupAdditionalGroupKeyArgs]] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        group_key: Optional[GroupGroupKeyArgs] = None,
        initial_group_config: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        update_time: Optional[str] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
resources:  _:    type: gcp:cloudidentity:Group    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdditionalGroupKeys List<GroupAdditionalGroupKey>
Additional group keys associated with the Group Structure is documented below.
CreateTime string
The time when the Group was created.
Description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string
The display name of the Group.
GroupKey Changes to this property will trigger replacement. GroupGroupKey
EntityKey of the Group. Structure is documented below.
InitialGroupConfig Changes to this property will trigger replacement. string
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
Labels Dictionary<string, string>
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
Name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
Parent Changes to this property will trigger replacement. string
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
UpdateTime string
The time when the Group was last updated.
AdditionalGroupKeys []GroupAdditionalGroupKeyArgs
Additional group keys associated with the Group Structure is documented below.
CreateTime string
The time when the Group was created.
Description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string
The display name of the Group.
GroupKey Changes to this property will trigger replacement. GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
InitialGroupConfig Changes to this property will trigger replacement. string
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
Labels map[string]string
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
Name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
Parent Changes to this property will trigger replacement. string
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
UpdateTime string
The time when the Group was last updated.
additionalGroupKeys List<GroupAdditionalGroupKey>
Additional group keys associated with the Group Structure is documented below.
createTime String
The time when the Group was created.
description String
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName String
The display name of the Group.
groupKey Changes to this property will trigger replacement. GroupGroupKey
EntityKey of the Group. Structure is documented below.
initialGroupConfig Changes to this property will trigger replacement. String
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
labels Map<String,String>
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
name String
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
parent Changes to this property will trigger replacement. String
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
updateTime String
The time when the Group was last updated.
additionalGroupKeys GroupAdditionalGroupKey[]
Additional group keys associated with the Group Structure is documented below.
createTime string
The time when the Group was created.
description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName string
The display name of the Group.
groupKey Changes to this property will trigger replacement. GroupGroupKey
EntityKey of the Group. Structure is documented below.
initialGroupConfig Changes to this property will trigger replacement. string
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
labels {[key: string]: string}
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
parent Changes to this property will trigger replacement. string
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
updateTime string
The time when the Group was last updated.
additional_group_keys Sequence[GroupAdditionalGroupKeyArgs]
Additional group keys associated with the Group Structure is documented below.
create_time str
The time when the Group was created.
description str
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
display_name str
The display name of the Group.
group_key Changes to this property will trigger replacement. GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
initial_group_config Changes to this property will trigger replacement. str
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
labels Mapping[str, str]
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
name str
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
parent Changes to this property will trigger replacement. str
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
update_time str
The time when the Group was last updated.
additionalGroupKeys List<Property Map>
Additional group keys associated with the Group Structure is documented below.
createTime String
The time when the Group was created.
description String
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName String
The display name of the Group.
groupKey Changes to this property will trigger replacement. Property Map
EntityKey of the Group. Structure is documented below.
initialGroupConfig Changes to this property will trigger replacement. String
The initial configuration options for creating a Group. See the API reference for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]
labels Map<String>
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.
name String
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
parent Changes to this property will trigger replacement. String
The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source_id} for external-identity-mapped groups or customers/{customer_id} for Google Groups.
updateTime String
The time when the Group was last updated.

Supporting Types

GroupAdditionalGroupKey
, GroupAdditionalGroupKeyArgs

Id string
(Output) The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
Namespace string
(Output) The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
Id string
(Output) The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
Namespace string
(Output) The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
id String
(Output) The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace String
(Output) The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
id string
(Output) The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace string
(Output) The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
id str
(Output) The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace str
(Output) The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.
id String
(Output) The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace String
(Output) The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

GroupGroupKey
, GroupGroupKeyArgs

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
Namespace Changes to this property will trigger replacement. string
The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

Id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
Namespace Changes to this property will trigger replacement. string
The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace Changes to this property will trigger replacement. String
The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id
This property is required.
Changes to this property will trigger replacement.
string
The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace Changes to this property will trigger replacement. string
The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace Changes to this property will trigger replacement. str
The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id
This property is required.
Changes to this property will trigger replacement.
String
The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.
namespace Changes to this property will trigger replacement. String
The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

Import

Group can be imported using any of these accepted formats:

  • {{name}}

When using the pulumi import command, Group can be imported using one of the formats above. For example:

$ pulumi import gcp:cloudidentity/group:Group default {{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp