Method: groups.list

Mengambil semua grup domain atau pengguna tertentu berdasarkan userKey (berpaginasi).

Permintaan HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
customer

string

ID unik untuk akun Google Workspace pelanggan. Jika akun multi-domain, untuk mengambil semua grup pelanggan, gunakan kolom ini, bukan domain. Anda juga dapat menggunakan alias my_customer untuk merepresentasikan 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. Berisi satu atau beberapa klausa penelusuran, yang masing-masing memiliki kolom, operator, dan nilai. Untuk dokumentasi lengkap, buka Menelusuri grup.
sortOrder

enum (SortOrder)

Apakah akan menampilkan hasil dalam urutan menaik atau menurun. Hanya berguna jika orderBy juga digunakan
userKey

string

Email atau ID tetap pengguna jika hanya grup tersebut yang akan dicantumkan, pengguna yang diberikan adalah anggota. 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.

OrderBy

Enum
EMAIL Email grup.

SortOrder

Enum
ASCENDING Urutan menaik.
DESCENDING Urutan menurun.