Method: groups.list
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Bir alan adının veya kullanıcı anahtarı verilen bir kullanıcının tüm gruplarını getirir (sayfalandırılmış).
HTTP isteği
GET https://admin.googleapis.com/admin/directory/v1/groups
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Sorgu parametreleri
Parametreler |
customer |
string
Müşterinin Google Workspace hesabının benzersiz kimliği. Birden fazla alan adı içeren bir hesapta, bir müşterinin tüm gruplarını almak için domain yerine bu alanı kullanın. Hesabınızın customerId değerini temsil etmek için my_customer takma adını da kullanabilirsiniz. customerId , Users kaynağının bir parçası olarak da döndürülür. customer veya domain parametresini sağlamanız gerekir.
|
domain |
string
Alan adı. Yalnızca bir alandan grup almak için bu alanı kullanın. Bir müşteri hesabının tüm alanlarını döndürmek için bunun yerine customer sorgu parametresini kullanın.
|
maxResults |
integer
Döndürülecek maksimum sonuç sayısı. İzin verilen maksimum değer 200'dür.
|
orderBy |
enum (OrderBy )
Sonuçları sıralamak için kullanılacak sütun
|
pageToken |
string
Listede sonraki sayfayı belirtmek için jeton
|
query |
string
Sorgu dizesi araması. "" biçiminde olmalıdır. Tam dokümanlar https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups adresindedir.
|
sortOrder |
enum (SortOrder )
Sonuçların artan düzende mi yoksa azalan düzende mi döndürüleceğini belirtir. Yalnızca orderBy da kullanıldığında yararlıdır.
|
userKey |
string
Yalnızca söz konusu kullanıcının üyesi olduğu grupların listeleneceği durumlarda, kullanıcının e-posta adresi veya değişmez kimliği. Kimlik ise kullanıcı nesnesinin kimliğiyle eşleşmelidir. customer parametresiyle kullanılamaz.
|
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
{
"kind": string,
"etag": string,
"groups": [
{
object (Group )
}
],
"nextPageToken": string
} |
Alanlar |
kind |
string
Bu kaynağın türü.
|
etag |
string
Kaynağın ETag'i.
|
groups[] |
object (Group )
Grup nesnelerinin listesi.
|
nextPageToken |
string
Bu sonucun bir sonraki sayfasına erişmek için kullanılan jeton.
|
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
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
Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
Şuna göre sırala
Sıralamalar |
EMAIL |
Grubun e-posta adresi. |
SortOrder
Sıralamalar |
ASCENDING |
Artan düzen. |
DESCENDING |
Azalan düzen. |
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 2025-07-25 UTC."],[],[],null,["# Method: groups.list\n\nRetrieves all groups of a domain or of a user given a userKey (paginated).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/groups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |\n| `domain` | `string` The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. |\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 200. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/groups/list#OrderBy)`)` Column to use for sorting results |\n| `pageToken` | `string` Token to specify next page in the list |\n| `query` | `string` Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/groups/list#SortOrder)`)` Whether to return results in ascending or descending order. Only of use when orderBy is also used |\n| `userKey` | `string` Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. Cannot be used with the `customer` parameter. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"groups\": [ { object (/workspace/admin/directory/reference/rest/v1/groups#Group) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `groups[]` | `object (`[Group](/workspace/admin/directory/reference/rest/v1/groups#Group)`)` A list of group objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nOrderBy\n-------\n\n| Enums ||\n|---------|---------------------|\n| `EMAIL` | Email of the group. |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |"]]