將成員新增至群組
如要將成員新增至群組,請使用下列 POST
要求並納入授權要求中所述的授權。群組成員可以是使用者或其他群組。groupKey
是新成員的群組電子郵件地址或群組專屬的 id
。如需要求和回應屬性,請參閱 API 參考資料:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
如果您將群組新增為其他群組的成員,下層群組的成員可能需要等候 10 分鐘,才會以上層群組成員的形式顯示。此外,API 還會針對群組成員中的週期傳回錯誤。舉例來說,如果 group1 是 group2 的成員,group2 就無法是 group1 的成員。
JSON 要求
以下 JSON 要求顯示建立群組成員的範例要求主體。成員的電子郵件地址是 liz@example.com,成員中的群組角色為 MEMBER
。POST
要求用於 groupKey
的 NNNNN:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{ "email": "liz@example.com", "role": "MEMBER" }
群組成員的role
可能是:
OWNER
:這個角色可以變更傳送給群組的訊息、新增或移除成員、變更成員角色、變更群組設定,以及刪除群組。OWNER
必須是群組成員。MANAGER
– 您必須使用管理控制台啟用 Google Workspace,才能使用這個角色。「管理員」角色可執行「擁有者」角色完成的所有動作,但無法將成員設為「擁有者」或刪除群組。一個群組可以有多位擁有者和管理員成員。MEMBER
– 這個角色可以訂閱群組、查看討論封存資料及查看群組的成員資格清單。如要進一步瞭解成員角色,請參閱管理員說明中心。
JSON 回應
如果傳回成功的回應,系統會傳回 HTTP 200 狀態碼和成員的成員資訊。id
是會員的專屬 ID:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
群組成員的type
可能是:
GROUP
:成員是另一個群組。MEMBER
:成員是使用者
更新群組成員資格
如要更新群組成員,請使用下列 PUT
要求,並附上授權要求中所述的授權。groupKey
是群組的電子郵件地址或群組的專屬 id
,而 memberKey
是使用者或群組的主要電子郵件地址、使用者別名或使用者的專屬 id
。如需要求和回應屬性,請參閱 API 參考資料:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON 要求
以下 JSON 要求顯示更新群組成員設定的要求主體範例,成員的電子郵件地址是 liz@example.com,而且群組中的成員角色已從 MEMBER
變更為 MANAGER
。在這個範例中,PUT
要求和 groupKey
是 NNNNN。如要瞭解「成員」、「擁有者」和「管理員」角色的相關資訊,請參閱管理員說明中心:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{ "email": "liz@example.com", "role": "MANAGER" }
JSON 回應
如果傳回成功的回應,系統會傳回 HTTP 200 狀態碼和更新後的成員資格資訊。id
是會員的專屬 ID:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
擷取群組成員
如要擷取群組成員,請使用下列 GET
要求,並附上授權要求中所述的授權。groupKey
是群組的電子郵件地址或群組的專屬 id
,而 memberKey
是使用者或群組的主要電子郵件地址、使用者別名或使用者的專屬 id
。如需要求和回應屬性,請參閱 API 參考資料:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON 回應
如果傳回成功的回應,系統會傳回 HTTP 200 狀態碼和成員的成員資訊。id
是會員的專屬 ID:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
擷取所有群組成員
如要擷取所有群組成員,請使用下列 GET
要求並加入授權要求中所述的授權。groupKey
是群組的電子郵件地址或群組的專屬 id
。選用的 roles
查詢字串是一種篩選器,可讓您依照角色擷取群組成員,而角色角色集合的順序會以 roles
篩選器中的指定順序排列。如要瞭解要求和回應屬性,請參閱 API 參考資料。為了方便閱讀,這個範例使用行回傳功能:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members ?pageToken=pagination token &roles=one or more of OWNER,MANAGER,MEMBER separated by a comma &maxResults=maximum results per response page
所有成員將依照字母順序,傳回成員的字母和電子郵件地址。對於回應大量成員的回應,請使用 pageToken
查詢字串。在分頁的情況下,回應會傳回 nextPageToken
屬性,其中包含下一頁的回應結果符記。下一個要求會使用這個權杖做為 pageToken
查詢字串值。
JSON 回應
成功的回應會傳回 HTTP 200 狀態碼和成員資訊清單。id
是會員的專屬會員 ID。在這個回應中,群組成員的後續追蹤清單有 nextPageToken
:
{ "kind": "directory#members", "members": [ { "kind": "directory#member", "id": "group member's unique ID", "email": "liz@example.com", "role": "MANAGER", "type": "GROUP" }, { "kind": "directory#member", "id": "group member's unique ID", "email": "radhe@example.com", "role": "MANAGER", "type": "MEMBER" } ], "nextPageToken": "NNNNN" }
刪除群組中的成員資格
如要刪除群組成員中的成員,請使用下列 DELETE
要求,並附上授權要求中所述的授權。groupKey
是群組的專屬 id
,memberKey
則是已刪除的使用者或群組成員的主要電子郵件地址或使用者的 id
。如要瞭解要求和回應屬性,請參閱 API 參考資料:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey舉例來說,這個
DELETE
要求會刪除 groupKey
為 nnn 且成員為使用者的主要電子郵件地址 liz@example.com 的 memberKey
。
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
成功的回應會傳回 HTTP 200 狀態碼。
成員刪除後:
- 你移除的成員不會再收到群組寄送的電子郵件。
- 從群組中移除成員並不會刪除該帳戶。
- 即使您刪除群組擁有者,群組仍可正常運作。管理員可以管理群組,或是將擁有權指派給其他群組成員