GroupMembership class

A Membership defines a relationship between a Group and an entity belonging to that Group, referred to as a "member".

To get more information about GroupMembership, see:

• API documentation
• How-to Guides
• Official Documentation

> Warning: If you are using User ADCs (Application Default Credentials) with this resource, you must specify a billingProject and set userProjectOverride 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 billingProject you defined.

Example Usage

Cloud Identity Group Membership

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

const group = new gcp.cloudidentity.Group("group", {
    displayName: "my-identity-group",
    parent: "customers/A01b123xz",
    groupKey: {
        id: "[e-mail]",
    },
    labels: {
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    },
});
const child_group = new gcp.cloudidentity.Group("child-group", {
    displayName: "my-identity-group-child",
    parent: "customers/A01b123xz",
    groupKey: {
        id: "[e-mail]",
    },
    labels: {
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    },
});
const cloudIdentityGroupMembershipBasic = new gcp.cloudidentity.GroupMembership("cloud_identity_group_membership_basic", {
    group: group.id,
    preferredMemberKey: {
        id: child_group.groupKey.id,
    },
    roles: [{
        name: "MEMBER",
    }],
});

import pulumi
import pulumi_gcp as gcp

group = gcp.cloudidentity.Group("group",
    display_name="my-identity-group",
    parent="customers/A01b123xz",
    group_key={
        "id": "[e-mail]",
    },
    labels={
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    })
child_group = gcp.cloudidentity.Group("child-group",
    display_name="my-identity-group-child",
    parent="customers/A01b123xz",
    group_key={
        "id": "[e-mail]",
    },
    labels={
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    })
cloud_identity_group_membership_basic = gcp.cloudidentity.GroupMembership("cloud_identity_group_membership_basic",
    group=group.id,
    preferred_member_key={
        "id": child_group.group_key.id,
    },
    roles=[{
        "name": "MEMBER",
    }])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

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

    var child_group = new Gcp.CloudIdentity.Group("child-group", new()
    {
        DisplayName = "my-identity-group-child",
        Parent = "customers/A01b123xz",
        GroupKey = new Gcp.CloudIdentity.Inputs.GroupGroupKeyArgs
        {
            Id = "[e-mail]",
        },
        Labels =
        {
            { "cloudidentity.googleapis.com/groups.discussion_forum", "" },
        },
    });

    var cloudIdentityGroupMembershipBasic = new Gcp.CloudIdentity.GroupMembership("cloud_identity_group_membership_basic", new()
    {
        Group = @group.Id,
        PreferredMemberKey = new Gcp.CloudIdentity.Inputs.GroupMembershipPreferredMemberKeyArgs
        {
            Id = child_group.GroupKey.Apply(groupKey => groupKey.Id),
        },
        Roles = new[]
        {
            new Gcp.CloudIdentity.Inputs.GroupMembershipRoleArgs
            {
                Name = "MEMBER",
            },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		group, err := cloudidentity.NewGroup(ctx, "group", &cloudidentity.GroupArgs{
			DisplayName: pulumi.String("my-identity-group"),
			Parent:      pulumi.String("customers/A01b123xz"),
			GroupKey: &cloudidentity.GroupGroupKeyArgs{
				Id: pulumi.String("[e-mail]"),
			},
			Labels: pulumi.StringMap{
				"cloudidentity.googleapis.com/groups.discussion_forum": pulumi.String(""),
			},
		})
		if err != nil {
			return err
		}
		child_group, err := cloudidentity.NewGroup(ctx, "child-group", &cloudidentity.GroupArgs{
			DisplayName: pulumi.String("my-identity-group-child"),
			Parent:      pulumi.String("customers/A01b123xz"),
			GroupKey: &cloudidentity.GroupGroupKeyArgs{
				Id: pulumi.String("[e-mail]"),
			},
			Labels: pulumi.StringMap{
				"cloudidentity.googleapis.com/groups.discussion_forum": pulumi.String(""),
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudidentity.NewGroupMembership(ctx, "cloud_identity_group_membership_basic", &cloudidentity.GroupMembershipArgs{
			Group: group.ID().ToIDOutput().ToStringOutput(),
			PreferredMemberKey: &cloudidentity.GroupMembershipPreferredMemberKeyArgs{
				Id: child_group.GroupKey.Id(),
			},
			Roles: cloudidentity.GroupMembershipRoleArray{
				&cloudidentity.GroupMembershipRoleArgs{
					Name: pulumi.String("MEMBER"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_cloudidentity_group" "group" {
  display_name = "my-identity-group"
  parent       = "customers/A01b123xz"
  group_key = {
    id = "[e-mail]"
  }
  labels = {
    "cloudidentity.googleapis.com/groups.discussion_forum" = ""
  }
}
resource "gcp_cloudidentity_group" "child-group" {
  display_name = "my-identity-group-child"
  parent       = "customers/A01b123xz"
  group_key = {
    id = "[e-mail]"
  }
  labels = {
    "cloudidentity.googleapis.com/groups.discussion_forum" = ""
  }
}
resource "gcp_cloudidentity_groupmembership" "cloud_identity_group_membership_basic" {
  group = gcp_cloudidentity_group.group.id
  preferred_member_key = {
    id = gcp_cloudidentity_group.child-group.group_key.id
  }
  roles {
    name = "MEMBER"
  }
}

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 com.pulumi.gcp.cloudidentity.GroupMembership;
import com.pulumi.gcp.cloudidentity.GroupMembershipArgs;
import com.pulumi.gcp.cloudidentity.inputs.GroupMembershipPreferredMemberKeyArgs;
import com.pulumi.gcp.cloudidentity.inputs.GroupMembershipRoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 group = new Group("group", GroupArgs.builder()
            .displayName("my-identity-group")
            .parent("customers/A01b123xz")
            .groupKey(GroupGroupKeyArgs.builder()
                .id("[e-mail]")
                .build())
            .labels(Map.of("cloudidentity.googleapis.com/groups.discussion_forum", ""))
            .build());

        var child_group = new Group("child-group", GroupArgs.builder()
            .displayName("my-identity-group-child")
            .parent("customers/A01b123xz")
            .groupKey(GroupGroupKeyArgs.builder()
                .id("[e-mail]")
                .build())
            .labels(Map.of("cloudidentity.googleapis.com/groups.discussion_forum", ""))
            .build());

        var cloudIdentityGroupMembershipBasic = new GroupMembership("cloudIdentityGroupMembershipBasic", GroupMembershipArgs.builder()
            .group(group.id())
            .preferredMemberKey(GroupMembershipPreferredMemberKeyArgs.builder()
                .id(child_group.groupKey().applyValue(_groupKey -> _groupKey.id()))
                .build())
            .roles(GroupMembershipRoleArgs.builder()
                .name("MEMBER")
                .build())
            .build());

    }
}

resources:
  group:
    type: gcp:cloudidentity:Group
    properties:
      displayName: my-identity-group
      parent: customers/A01b123xz
      groupKey:
        id: [e-mail]
      labels:
        cloudidentity.googleapis.com/groups.discussion_forum: ""
  child-group:
    type: gcp:cloudidentity:Group
    properties:
      displayName: my-identity-group-child
      parent: customers/A01b123xz
      groupKey:
        id: [e-mail]
      labels:
        cloudidentity.googleapis.com/groups.discussion_forum: ""
  cloudIdentityGroupMembershipBasic:
    type: gcp:cloudidentity:GroupMembership
    name: cloud_identity_group_membership_basic
    properties:
      group: ${group.id}
      preferredMemberKey:
        id: ${["child-group"].groupKey.id}
      roles:
        - name: MEMBER

Cloud Identity Group Membership User

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

const group = new gcp.cloudidentity.Group("group", {
    displayName: "my-identity-group",
    parent: "customers/A01b123xz",
    groupKey: {
        id: "[e-mail]",
    },
    labels: {
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    },
});
const cloudIdentityGroupMembershipBasic = new gcp.cloudidentity.GroupMembership("cloud_identity_group_membership_basic", {
    group: group.id,
    preferredMemberKey: {
        id: "[e-mail]",
    },
    roles: [
        {
            name: "MEMBER",
        },
        {
            name: "MANAGER",
        },
    ],
});

import pulumi
import pulumi_gcp as gcp

group = gcp.cloudidentity.Group("group",
    display_name="my-identity-group",
    parent="customers/A01b123xz",
    group_key={
        "id": "[e-mail]",
    },
    labels={
        "cloudidentity.googleapis.com/groups.discussion_forum": "",
    })
cloud_identity_group_membership_basic = gcp.cloudidentity.GroupMembership("cloud_identity_group_membership_basic",
    group=group.id,
    preferred_member_key={
        "id": "[e-mail]",
    },
    roles=[
        {
            "name": "MEMBER",
        },
        {
            "name": "MANAGER",
        },
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

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

    var cloudIdentityGroupMembershipBasic = new Gcp.CloudIdentity.GroupMembership("cloud_identity_group_membership_basic", new()
    {
        Group = @group.Id,
        PreferredMemberKey = new Gcp.CloudIdentity.Inputs.GroupMembershipPreferredMemberKeyArgs
        {
            Id = "[e-mail]",
        },
        Roles = new[]
        {
            new Gcp.CloudIdentity.Inputs.GroupMembershipRoleArgs
            {
                Name = "MEMBER",
            },
            new Gcp.CloudIdentity.Inputs.GroupMembershipRoleArgs
            {
                Name = "MANAGER",
            },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		group, err := cloudidentity.NewGroup(ctx, "group", &cloudidentity.GroupArgs{
			DisplayName: pulumi.String("my-identity-group"),
			Parent:      pulumi.String("customers/A01b123xz"),
			GroupKey: &cloudidentity.GroupGroupKeyArgs{
				Id: pulumi.String("[e-mail]"),
			},
			Labels: pulumi.StringMap{
				"cloudidentity.googleapis.com/groups.discussion_forum": pulumi.String(""),
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudidentity.NewGroupMembership(ctx, "cloud_identity_group_membership_basic", &cloudidentity.GroupMembershipArgs{
			Group: group.ID().ToIDOutput().ToStringOutput(),
			PreferredMemberKey: &cloudidentity.GroupMembershipPreferredMemberKeyArgs{
				Id: pulumi.String("[e-mail]"),
			},
			Roles: cloudidentity.GroupMembershipRoleArray{
				&cloudidentity.GroupMembershipRoleArgs{
					Name: pulumi.String("MEMBER"),
				},
				&cloudidentity.GroupMembershipRoleArgs{
					Name: pulumi.String("MANAGER"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_cloudidentity_group" "group" {
  display_name = "my-identity-group"
  parent       = "customers/A01b123xz"
  group_key = {
    id = "[e-mail]"
  }
  labels = {
    "cloudidentity.googleapis.com/groups.discussion_forum" = ""
  }
}
resource "gcp_cloudidentity_groupmembership" "cloud_identity_group_membership_basic" {
  group = gcp_cloudidentity_group.group.id
  preferred_member_key = {
    id = "[e-mail]"
  }
  roles {
    name = "MEMBER"
  }
  roles {
    name = "MANAGER"
  }
}

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 com.pulumi.gcp.cloudidentity.GroupMembership;
import com.pulumi.gcp.cloudidentity.GroupMembershipArgs;
import com.pulumi.gcp.cloudidentity.inputs.GroupMembershipPreferredMemberKeyArgs;
import com.pulumi.gcp.cloudidentity.inputs.GroupMembershipRoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 group = new Group("group", GroupArgs.builder()
            .displayName("my-identity-group")
            .parent("customers/A01b123xz")
            .groupKey(GroupGroupKeyArgs.builder()
                .id("[e-mail]")
                .build())
            .labels(Map.of("cloudidentity.googleapis.com/groups.discussion_forum", ""))
            .build());

        var cloudIdentityGroupMembershipBasic = new GroupMembership("cloudIdentityGroupMembershipBasic", GroupMembershipArgs.builder()
            .group(group.id())
            .preferredMemberKey(GroupMembershipPreferredMemberKeyArgs.builder()
                .id("[e-mail]")
                .build())
            .roles(
                GroupMembershipRoleArgs.builder()
                    .name("MEMBER")
                    .build(),
                GroupMembershipRoleArgs.builder()
                    .name("MANAGER")
                    .build())
            .build());

    }
}

resources:
  group:
    type: gcp:cloudidentity:Group
    properties:
      displayName: my-identity-group
      parent: customers/A01b123xz
      groupKey:
        id: [e-mail]
      labels:
        cloudidentity.googleapis.com/groups.discussion_forum: ""
  cloudIdentityGroupMembershipBasic:
    type: gcp:cloudidentity:GroupMembership
    name: cloud_identity_group_membership_basic
    properties:
      group: ${group.id}
      preferredMemberKey:
        id: [e-mail]
      roles:
        - name: MEMBER
        - name: MANAGER

Import

GroupMembership can be imported using any of these accepted formats:

• {{name}}

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

$ pulumi import gcp:cloudidentity/groupMembership:GroupMembership default {{name}}

Constructors

GroupMembership(String name, {GroupMembershipArgs? args, CustomResourceOptions? options})

Creates a new GroupMembership. name The Pulumi resource name. args Arguments used to configure this GroupMembership. The set of arguments for GroupMembership. options Resource options controlling this resource's behavior.

GroupMembership.reference(String urn)

Creates a typed reference to an existing GroupMembership resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createIgnoreAlreadyExists ↔ Output<bool?>

If set to true, skip group member creation if a membership with the same name already exists. Defaults to false.

late, final

createTime ↔ Output<String>

The time when the Membership was created.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

group ↔ Output<String>

The name of the Group to create this membership in.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

memberKey ↔ Output<GroupMembershipMemberKey>

(Optional, Beta) EntityKey of the member. Structure is documented below.

late, final

name ↔ Output<String>

The resource name of the Membership, of the form groups/{group_id}/memberships/{membership_id}.

late, final

preferredMemberKey ↔ Output<GroupMembershipPreferredMemberKey>

EntityKey of the member. Structure is documented below.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

roles ↔ Output<List<GroupMembershipRole>>

The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String>

The type of the membership.

late, final

updateTime ↔ Output<String>

The time when the Membership was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {GroupMembershipState? state, CustomResourceOptions? options}) → GroupMembership

Gets an existing GroupMembership resource's state with the given name and id.