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

更新组的属性。