透過已分頁的方式擷取網域的所有群組或使用者的所有群組 (已分頁)。
HTTP 要求
GET https://admin.googleapis.com/admin/directory/v1/groups
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
customer |
客戶 Google Workspace 帳戶的專屬 ID。在多網域帳戶的情況下,如要擷取客戶的所有群組,請使用這個欄位,而不是 |
domain |
網域名稱。使用這個欄位即可只從單一網域取得群組。如要傳回客戶帳戶的所有網域,請改用 |
maxResults |
要傳回的結果數上限。允許的最大值為 200。 |
orderBy |
用於排序結果的資料欄 |
pageToken |
用於指定清單中下一頁的權杖 |
query |
查詢字串搜尋。格式應為「 |
sortOrder |
要依遞增或遞減順序傳回結果。僅使用 orderBy 時才使用 |
userKey |
如果系統只列出使用者所屬的群組,請提供使用者的電子郵件或不可變更 ID。如果是 ID,則必須與使用者物件 ID 相符。 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
欄位 | |
---|---|
kind |
資源種類。 |
etag |
資源的 ETag。 |
groups[] |
群組物件清單。 |
nextPageToken |
存取此結果下一頁的權杖。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://apps-apis.google.com/a/feeds/groups/
https://www.googleapis.com/auth/admin.directory.group
https://www.googleapis.com/auth/admin.directory.group.readonly
詳情請參閱授權指南。
OrderBy
列舉 | |
---|---|
EMAIL |
群組的電子郵件地址。 |
SortOrder
列舉 | |
---|---|
ASCENDING |
遞增順序。 |
DESCENDING |
遞減排序。 |