Members

A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the Developer's Guide.

For a list of methods for this resource, see the end of this page.

Resource representations

The following JSON template is used for Members resources in the Directory API:

{
  "kind": "admin#directory#member",
  "etag": etag,
  "id": string,
  "email": string,
  "role": string,
  "type": string,
  "status": string,
  "delivery_settings": string
}
Property name Value Description Notes
delivery_settings string 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.
writable
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 etag ETag of the resource.
id string The unique ID of the group member. A member id can be used as a member request URI's memberKey.
kind string The type of the API resource. For Members resources, the value is admin#directory#member.
role string 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. For more information about a member's role, see the administration help center.

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. For more information about member roles, see the administration help center.
  • "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.
writable
status string Status of member (Immutable)

Acceptable values are:
  • "ACTIVE"
  • "ARCHIVED"
  • "SUSPENDED"
  • "UNKNOWN"
type string 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.
  • "EXTERNAL": The member is a user or group from outside the domain. (Not currently used)
  • "GROUP": The member is another group.
  • "USER": The member is a user.

Methods

delete
Removes a member from a group.
get
Retrieves a group member's properties.
hasMember
Checks whether the given user is a member of the group. Membership can be direct or nested.
insert
Adds a user to the specified group.
list
Retrieves a paginated list of all members in a group.
patch
Updates the membership properties of a user in the specified group. This method supports patch semantics.
update
Updates the membership of a user in the specified group.

Send feedback about...

Directory API
Directory API
Need help? Visit our support page.