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

擷取使用者金鑰 (分頁) 的所有網域或使用者群組。

patch

更新群組屬性。

update

更新群組屬性。