groups

Overview

Name	groups
Type	Resource
Id	googleadmin.directory.groups

Fields

Name	Datatype	Description
id	string	Read-only. The unique ID of a group. A group id can be used as a group request URI's groupKey.
name	string	The group's display name.
description	string	An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is 4,096 characters.
adminCreated	boolean	Read-only. Value is true if this group was created by an administrator rather than a user.
aliases	array	Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the groups.aliases methods. If edited in a group's POST or PUT request, the edit is ignored.
directMembersCount	string	The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the directMembersCount property of the parent group.
email	string	The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The email must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the help center for details.
etag	string	ETag of the resource.
kind	string	The type of the API resource. For Groups resources, the value is admin#directory#group.
nonEditableAliases	array	Read-only. The list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	groupKey	Retrieves a group's properties.
list	SELECT	domain	Retrieves all groups of a domain or of a user given a userKey (paginated).
insert	INSERT		Creates a group.
delete	DELETE	groupKey	Deletes a group.
_list	EXEC	domain	Retrieves all groups of a domain or of a user given a userKey (paginated).
patch	EXEC	groupKey	Updates a group's properties. This method supports patch semantics.
update	EXEC	groupKey	Updates a group's properties.