Menyediakan daftar profil domain dan kontak domain di direktori domain pengguna yang diautentikasi.
Jika
ditentukan, resource yang dihapus sejak sinkronisasi terakhir akan ditampilkan sebagai orang dengan syncToken
ditetapkan ke true (benar).PersonMetadata.deleted
Jika
atau pageToken
ditentukan, semua parameter permintaan lainnya harus cocok dengan panggilan pertama.syncToken
Operasi tulis mungkin memiliki penundaan penerapan beberapa menit untuk permintaan sinkronisasi. Sinkronisasi inkremental tidak dimaksudkan untuk kasus penggunaan baca-setelah-tulis.
Lihat contoh penggunaan di Menampilkan daftar direktori orang yang telah berubah.
Permintaan HTTP
GET https://people.googleapis.com/v1/people:listDirectoryPeople
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
Parameter | |
---|---|
readMask |
Wajib diisi. Mask kolom untuk membatasi kolom mana pada setiap orang yang ditampilkan. Beberapa kolom dapat ditentukan dengan memisahkannya dengan koma. Nilai yang valid adalah:
|
sources[] |
Wajib diisi. Sumber direktori yang akan ditampilkan. |
mergeSources[] |
Opsional. Data tambahan untuk digabungkan ke sumber direktori jika terhubung melalui kunci join yang diverifikasi seperti alamat email atau nomor telepon. |
pageSize |
Opsional. Jumlah orang yang akan disertakan dalam respons. Nilai yang valid adalah antara 1 dan 1000, inklusif. Jika tidak ditetapkan atau ditetapkan ke 0, nilai defaultnya adalah 100. |
pageToken |
Opsional. Token halaman, diterima dari respons Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk |
requestSyncToken |
Opsional. Apakah respons harus menampilkan Detail selengkapnya tentang perilaku sinkronisasi di |
syncToken |
Opsional. Token sinkronisasi, diterima dari respons sebelumnya Saat menyinkronkan, semua parameter lain yang disediakan untuk Detail selengkapnya tentang perilaku sinkronisasi di |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Respons terhadap permintaan untuk direktori domain pengguna yang diautentikasi.
Representasi JSON |
---|
{
"people": [
{
object ( |
Kolom | |
---|---|
people[] |
Daftar orang di direktori domain. |
nextPageToken |
Token yang dapat dikirim sebagai |
nextSyncToken |
Token yang dapat dikirim sebagai |
Cakupan Otorisasi
Memerlukan cakupan OAuth berikut ini:
https://www.googleapis.com/auth/directory.readonly
Untuk mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.