Method: groups.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mengambil semua grup domain atau pengguna yang diberi userKey (di-pagination).
Permintaan HTTP
GET https://admin.googleapis.com/admin/directory/v1/groups
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
| Parameter |
customer |
string
ID unik untuk akun Google Workspace pelanggan. Jika akun memiliki beberapa domain, gunakan kolom ini, bukan domain, untuk mengambil semua grup bagi pelanggan. Anda juga dapat menggunakan alias my_customer untuk mewakili customerId akun Anda. customerId juga ditampilkan sebagai bagian dari resource Pengguna. Anda harus memberikan parameter customer atau domain.
|
domain |
string
Nama domain. Gunakan kolom ini untuk mendapatkan grup hanya dari satu domain. Untuk menampilkan semua domain untuk akun pelanggan, gunakan parameter kueri customer.
|
maxResults |
integer
Jumlah hasil maksimum yang akan ditampilkan. Nilai maksimum yang diizinkan adalah 200.
|
orderBy |
enum (OrderBy)
Kolom yang akan digunakan untuk mengurutkan hasil
|
pageToken |
string
Token untuk menentukan halaman berikutnya dalam daftar
|
query |
string
Penelusuran string kueri. Harus dalam bentuk "". Dokumentasi lengkapnya ada di https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups
|
sortOrder |
enum (SortOrder)
Apakah akan menampilkan hasil dalam urutan menaik atau menurun. Hanya digunakan jika orderBy juga digunakan
|
userKey |
string
Email atau ID pengguna yang tidak dapat diubah jika hanya grup tersebut yang akan dicantumkan, pengguna yang diberikan adalah anggotanya. Jika berupa ID, ID tersebut harus cocok dengan ID objek pengguna. Tidak dapat digunakan dengan parameter customer.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"kind": string,
"etag": string,
"groups": [
{
object (Group)
}
],
"nextPageToken": string
} |
| Kolom |
kind |
string
Jenis resource ini.
|
etag |
string
ETag resource.
|
groups[] |
object (Group)
Daftar objek grup.
|
nextPageToken |
string
Token yang digunakan untuk mengakses halaman berikutnya dari hasil ini.
|
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
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
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
SortOrder
| Enum |
ASCENDING |
Urutan menaik. |
DESCENDING |
Urutan menurun. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]
