Group

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

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
    public MyStack()
    {
        var cloudIdentityGroupBasic = new Gcp.CloudIdentity.Group("cloudIdentityGroupBasic", new Gcp.CloudIdentity.GroupArgs
        {
            DisplayName = "my-identity-group",
            GroupKey = new Gcp.CloudIdentity.Inputs.GroupGroupKeyArgs
            {
                Id = "my-identity-group@example.com",
            },
            InitialGroupConfig = "WITH_INITIAL_OWNER",
            Labels = 
            {
                { "cloudidentity.googleapis.com/groups.discussion_forum", "" },
            },
            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.NewGroup(ctx, "cloudIdentityGroupBasic", &cloudidentity.GroupArgs{
			DisplayName: pulumi.String("my-identity-group"),
			GroupKey: &cloudidentity.GroupGroupKeyArgs{
				Id: pulumi.String("my-identity-group@example.com"),
			},
			InitialGroupConfig: pulumi.String("WITH_INITIAL_OWNER"),
			Labels: pulumi.StringMap{
				"cloudidentity.googleapis.com/groups.discussion_forum": pulumi.String(""),
			},
			Parent: pulumi.String("customers/A01b123xz"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_gcp as gcp

cloud_identity_group_basic = gcp.cloudidentity.Group("cloudIdentityGroupBasic",
    display_name="my-identity-group",
    group_key=gcp.cloudidentity.GroupGroupKeyArgs(
        id="my-identity-group@example.com",
    ),
    initial_group_config="WITH_INITIAL_OWNER",
    labels={
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    },
    parent="customers/A01b123xz")
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",
    groupKey: {
        id: "my-identity-group@example.com",
    },
    initialGroupConfig: "WITH_INITIAL_OWNER",
    labels: {
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    },
    parent: "customers/A01b123xz",
});

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = 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,
          parent: Optional[str] = None)
@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Group Resource Properties

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

Inputs

The Group resource accepts the following input properties:

GroupKey GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
Labels Dictionary<string, string>
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
Parent 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 string
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.
GroupKey GroupGroupKey
EntityKey of the Group. Structure is documented below.
Labels map[string]string
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
Parent 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 string
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.
groupKey GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
labels {[key: string]: string}
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
parent 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 string
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.
group_key GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
labels Mapping[str, str]
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
parent 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 str
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.

Outputs

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

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.
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.
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.
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.

Look up an 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,
        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)
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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:

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 GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
InitialGroupConfig string
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.
Labels Dictionary<string, string>
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
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 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.
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 GroupGroupKey
EntityKey of the Group. Structure is documented below.
InitialGroupConfig string
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.
Labels map[string]string
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
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 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.
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 GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
initialGroupConfig string
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.
labels {[key: string]: string}
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
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 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.
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 GroupGroupKeyArgs
EntityKey of the Group. Structure is documented below.
initial_group_config str
The initial configuration options for creating a Group. See the API reference for possible values. Default value is EMPTY. Possible values are INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, and EMPTY.
labels Mapping[str, str]
The labels that apply to the Group. Must not contain more than one entry. Must contain the entry ‘cloudidentity.googleapis.com/groups.discussion_forum’: '' if the Group is a Google Group or ‘system/groups/external’: '' if the Group is an external-identity-mapped group.
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 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.

Supporting Types

GroupGroupKey

Id 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 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 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 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 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 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 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 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}.

Import

Group can be imported using any of these accepted formats

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

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.