REST Resource: groups

资源：群组

借助 Google 群组，您的用户可以使用群组的电子邮件地址向群组发送邮件。如需详细了解常见任务，请参阅开发者指南。

如需了解其他类型的群组，请参阅 Cloud Identity Groups API 文档。

注意：调用 API 的用户（或被服务账号冒充的用户）必须被分配包含 Admin API 群组权限的角色，例如超级用户或群组管理员。

JSON 表示法 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
字段
id

string

只读。群组的唯一 ID。群组 id 可用作群组请求 URI 的 groupKey。
email

string

群组的电子邮件地址。如果您的账号有多个网域，请为电子邮件地址选择合适的网域。email 必须是唯一的。创建组时，此属性是必需的。群组电子邮件地址的字符使用规则与用户名相同，如需了解详情，请访问帮助中心。
name

string

群组的显示名称。
description

string

详细说明，可帮助用户确定群组的用途。举例来说，您可以说明哪些人应该加入该群组、应向群组发送哪些类型的邮件，还可以提供群组常见问题解答的链接或相关群组等信息。长度上限为 4,096 个字符。
adminCreated

boolean

只读。如果此群组是由管理员（而非用户）创建的，则值为 true。
directMembersCount

string (int64 format)

群组的直接成员数量。如果某个群组是此群组（父级群组）的成员（子群组），则子群组的成员不会计入父级群组的 directMembersCount 属性。
kind

string

API 资源的类型。对于“群组”资源，该值为 admin#directory#group。
etag

string

资源的 ETag。
aliases[]

string

只读。群组的别名电子邮件地址列表。如需添加、更新或移除群组的别名，请使用 groups.aliases 方法。如果在群组的 POST 或 PUT 请求中进行修改，系统会忽略相应修改。
nonEditableAliases[]

string

只读。群组的不可修改别名电子邮件地址列表（这些地址不在账号的主域名或子网域内）。这些是群组使用的有效电子邮件地址。这是 API 针对组返回的只读属性。如果在群组的 POST 或 PUT 请求中进行修改，系统会忽略相应修改。

方法

delete

 删除组。

get

 检索群组的属性。

insert

 创建群组。

list

 指定 userKey 后，检索网域或用户的所有群组（分页）。

patch

 更新群组的属性。

update

 更新群组的属性。