REST Resource: members

Resource: Member

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.

JSON representation
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
Fields
kind

string

The type of the API resource. For Members resources, the value is admin#directory#member.

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.

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.

etag

string

ETag of the resource.

type

string

The type of group member.

status

string

Status of member (Immutable)

delivery_settings

string

Defines mail delivery preferences of member. This is only supported by create/update/get.

id

string

The unique ID of the group member. A member id can be used as a member request URI's memberKey.

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.

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.

update

Updates the membership of a user in the specified group.