1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. GroupMember
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp

googleworkspace.GroupMember

Explore with Pulumi AI

Group Member resource manages Google Workspace Groups Members. Group Member resides under the https://www.googleapis.com/auth/admin.directory.group client scope.

Example Usage

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

const sales = new googleworkspace.Group("sales", {email: "sales@example.com"});
const michael = new googleworkspace.User("michael", {
    primaryEmail: "michael.scott@example.com",
    password: "34819d7beeabb9260a5c854bc85b3e44",
    hashFunction: "MD5",
    name: {
        familyName: "Scott",
        givenName: "Michael",
    },
});
const manager = new googleworkspace.GroupMember("manager", {
    groupId: sales.id,
    email: michael.primaryEmail,
    role: "MANAGER",
});
Copy
import pulumi
import pulumi_googleworkspace as googleworkspace

sales = googleworkspace.Group("sales", email="sales@example.com")
michael = googleworkspace.User("michael",
    primary_email="michael.scott@example.com",
    password="34819d7beeabb9260a5c854bc85b3e44",
    hash_function="MD5",
    name={
        "family_name": "Scott",
        "given_name": "Michael",
    })
manager = googleworkspace.GroupMember("manager",
    group_id=sales.id,
    email=michael.primary_email,
    role="MANAGER")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/googleworkspace/googleworkspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sales, err := googleworkspace.NewGroup(ctx, "sales", &googleworkspace.GroupArgs{
			Email: pulumi.String("sales@example.com"),
		})
		if err != nil {
			return err
		}
		michael, err := googleworkspace.NewUser(ctx, "michael", &googleworkspace.UserArgs{
			PrimaryEmail: pulumi.String("michael.scott@example.com"),
			Password:     pulumi.String("34819d7beeabb9260a5c854bc85b3e44"),
			HashFunction: pulumi.String("MD5"),
			Name: &googleworkspace.UserNameArgs{
				FamilyName: pulumi.String("Scott"),
				GivenName:  pulumi.String("Michael"),
			},
		})
		if err != nil {
			return err
		}
		_, err = googleworkspace.NewGroupMember(ctx, "manager", &googleworkspace.GroupMemberArgs{
			GroupId: sales.ID(),
			Email:   michael.PrimaryEmail,
			Role:    pulumi.String("MANAGER"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Googleworkspace = Pulumi.Googleworkspace;

return await Deployment.RunAsync(() => 
{
    var sales = new Googleworkspace.Group("sales", new()
    {
        Email = "sales@example.com",
    });

    var michael = new Googleworkspace.User("michael", new()
    {
        PrimaryEmail = "michael.scott@example.com",
        Password = "34819d7beeabb9260a5c854bc85b3e44",
        HashFunction = "MD5",
        Name = new Googleworkspace.Inputs.UserNameArgs
        {
            FamilyName = "Scott",
            GivenName = "Michael",
        },
    });

    var manager = new Googleworkspace.GroupMember("manager", new()
    {
        GroupId = sales.Id,
        Email = michael.PrimaryEmail,
        Role = "MANAGER",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.Group;
import com.pulumi.googleworkspace.GroupArgs;
import com.pulumi.googleworkspace.User;
import com.pulumi.googleworkspace.UserArgs;
import com.pulumi.googleworkspace.inputs.UserNameArgs;
import com.pulumi.googleworkspace.GroupMember;
import com.pulumi.googleworkspace.GroupMemberArgs;
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 sales = new Group("sales", GroupArgs.builder()
            .email("sales@example.com")
            .build());

        var michael = new User("michael", UserArgs.builder()
            .primaryEmail("michael.scott@example.com")
            .password("34819d7beeabb9260a5c854bc85b3e44")
            .hashFunction("MD5")
            .name(UserNameArgs.builder()
                .familyName("Scott")
                .givenName("Michael")
                .build())
            .build());

        var manager = new GroupMember("manager", GroupMemberArgs.builder()
            .groupId(sales.id())
            .email(michael.primaryEmail())
            .role("MANAGER")
            .build());

    }
}
Copy
resources:
  sales:
    type: googleworkspace:Group
    properties:
      email: sales@example.com
  michael:
    type: googleworkspace:User
    properties:
      primaryEmail: michael.scott@example.com
      password: 34819d7beeabb9260a5c854bc85b3e44
      hashFunction: MD5
      name:
        familyName: Scott
        givenName: Michael
  manager:
    type: googleworkspace:GroupMember
    properties:
      groupId: ${sales.id}
      email: ${michael.primaryEmail}
      role: MANAGER
Copy

Create GroupMember Resource

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

Constructor syntax

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

@overload
def GroupMember(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                email: Optional[str] = None,
                group_id: Optional[str] = None,
                delivery_settings: Optional[str] = None,
                role: Optional[str] = None,
                timeouts: Optional[GroupMemberTimeoutsArgs] = None,
                type: Optional[str] = None)
func NewGroupMember(ctx *Context, name string, args GroupMemberArgs, opts ...ResourceOption) (*GroupMember, error)
public GroupMember(string name, GroupMemberArgs args, CustomResourceOptions? opts = null)
public GroupMember(String name, GroupMemberArgs args)
public GroupMember(String name, GroupMemberArgs args, CustomResourceOptions options)
type: googleworkspace:GroupMember
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. GroupMemberArgs
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. GroupMemberArgs
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. GroupMemberArgs
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. GroupMemberArgs
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. GroupMemberArgs
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 groupMemberResource = new Googleworkspace.GroupMember("groupMemberResource", new()
{
    Email = "string",
    GroupId = "string",
    DeliverySettings = "string",
    Role = "string",
    Timeouts = new Googleworkspace.Inputs.GroupMemberTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
    Type = "string",
});
Copy
example, err := googleworkspace.NewGroupMember(ctx, "groupMemberResource", &googleworkspace.GroupMemberArgs{
Email: pulumi.String("string"),
GroupId: pulumi.String("string"),
DeliverySettings: pulumi.String("string"),
Role: pulumi.String("string"),
Timeouts: &.GroupMemberTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
Type: pulumi.String("string"),
})
Copy
var groupMemberResource = new GroupMember("groupMemberResource", GroupMemberArgs.builder()
    .email("string")
    .groupId("string")
    .deliverySettings("string")
    .role("string")
    .timeouts(GroupMemberTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .type("string")
    .build());
Copy
group_member_resource = googleworkspace.GroupMember("groupMemberResource",
    email="string",
    group_id="string",
    delivery_settings="string",
    role="string",
    timeouts={
        "create": "string",
        "update": "string",
    },
    type="string")
Copy
const groupMemberResource = new googleworkspace.GroupMember("groupMemberResource", {
    email: "string",
    groupId: "string",
    deliverySettings: "string",
    role: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
    type: "string",
});
Copy
type: googleworkspace:GroupMember
properties:
    deliverySettings: string
    email: string
    groupId: string
    role: string
    timeouts:
        create: string
        update: string
    type: string
Copy

GroupMember 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 GroupMember resource accepts the following input properties:

Email This property is required. string
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
GroupId This property is required. string
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
DeliverySettings string
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
Role string
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
Timeouts GroupMemberTimeouts
Type string
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
Email This property is required. string
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
GroupId This property is required. string
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
DeliverySettings string
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
Role string
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
Timeouts GroupMemberTimeoutsArgs
Type string
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
email This property is required. String
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
groupId This property is required. String
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
deliverySettings String
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
role String
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
timeouts GroupMemberTimeouts
type String
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
email This property is required. string
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
groupId This property is required. string
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
deliverySettings string
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
role string
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
timeouts GroupMemberTimeouts
type string
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
email This property is required. str
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
group_id This property is required. str
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
delivery_settings str
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
role str
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
timeouts GroupMemberTimeoutsArgs
type str
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
email This property is required. String
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
groupId This property is required. String
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
deliverySettings String
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
role String
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
timeouts Property Map
type String
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.

Outputs

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

Etag string
ETag of the resource.
Id string
The provider-assigned unique ID for this managed resource.
MemberId string
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
Status string
Status of member.
Etag string
ETag of the resource.
Id string
The provider-assigned unique ID for this managed resource.
MemberId string
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
Status string
Status of member.
etag String
ETag of the resource.
id String
The provider-assigned unique ID for this managed resource.
memberId String
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
status String
Status of member.
etag string
ETag of the resource.
id string
The provider-assigned unique ID for this managed resource.
memberId string
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
status string
Status of member.
etag str
ETag of the resource.
id str
The provider-assigned unique ID for this managed resource.
member_id str
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
status str
Status of member.
etag String
ETag of the resource.
id String
The provider-assigned unique ID for this managed resource.
memberId String
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
status String
Status of member.

Look up Existing GroupMember Resource

Get an existing GroupMember 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?: GroupMemberState, opts?: CustomResourceOptions): GroupMember
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delivery_settings: Optional[str] = None,
        email: Optional[str] = None,
        etag: Optional[str] = None,
        group_id: Optional[str] = None,
        member_id: Optional[str] = None,
        role: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[GroupMemberTimeoutsArgs] = None,
        type: Optional[str] = None) -> GroupMember
func GetGroupMember(ctx *Context, name string, id IDInput, state *GroupMemberState, opts ...ResourceOption) (*GroupMember, error)
public static GroupMember Get(string name, Input<string> id, GroupMemberState? state, CustomResourceOptions? opts = null)
public static GroupMember get(String name, Output<String> id, GroupMemberState state, CustomResourceOptions options)
resources:  _:    type: googleworkspace:GroupMember    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:
DeliverySettings string
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
Email string
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
Etag string
ETag of the resource.
GroupId string
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
MemberId string
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
Role string
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
Status string
Status of member.
Timeouts GroupMemberTimeouts
Type string
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
DeliverySettings string
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
Email string
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
Etag string
ETag of the resource.
GroupId string
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
MemberId string
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
Role string
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
Status string
Status of member.
Timeouts GroupMemberTimeoutsArgs
Type string
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
deliverySettings String
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
email String
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
etag String
ETag of the resource.
groupId String
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
memberId String
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
role String
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
status String
Status of member.
timeouts GroupMemberTimeouts
type String
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
deliverySettings string
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
email string
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
etag string
ETag of the resource.
groupId string
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
memberId string
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
role string
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
status string
Status of member.
timeouts GroupMemberTimeouts
type string
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
delivery_settings str
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
email str
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
etag str
ETag of the resource.
group_id str
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
member_id str
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
role str
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
status str
Status of member.
timeouts GroupMemberTimeoutsArgs
type str
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.
deliverySettings String
Defaults to ALL_MAIL. Defines mail delivery preferences of member. Acceptable values are: - ALL_MAIL: All messages, delivered as soon as they arrive. - DAILY: No more than one message a day. - DIGEST: Up to 25 messages bundled into a single message. - DISABLED: Remove subscription. - NONE: No messages.
email String
The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
etag String
ETag of the resource.
groupId String
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
memberId String
The unique ID of the group member. A member id can be used as a member request URI's memberKey.
role String
Defaults to MEMBER. The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. Acceptable values are: - MANAGER: This role is only available if the Google Groups for Business is enabled using the Admin Console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple MANAGER members. - MEMBER: This role can subscribe to a group, view discussion archives, and view the group's membership list. - OWNER: This role can send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An OWNER must be a member of the group. A group can have more than one OWNER.
status String
Status of member.
timeouts Property Map
type String
Defaults to USER. The type of group member. Acceptable values are: - CUSTOMER: The member represents all users in a domain. An email address is not returned and the ID returned is the customer ID. - GROUP: The member is another group.

  • USER: The member is a user.

Supporting Types

GroupMemberTimeouts
, GroupMemberTimeoutsArgs

Create string
Update string
Create string
Update string
create String
update String
create string
update string
create str
update str
create String
update String

Import

$ pulumi import googleworkspace:index/groupMember:GroupMember manager groups/01abcde23fg4h5i/members/123456789012345678901
Copy

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

Package Details

Repository
googleworkspace hashicorp/terraform-provider-googleworkspace
License
Notes
This Pulumi package is based on the googleworkspace Terraform Provider.