Mengamati perubahan dalam daftar pengguna.
Permintaan HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
Parameter | |
---|---|
domain |
Nama domain. Isi kolom ini untuk mendapatkan pengguna hanya dari domain ini. Untuk menampilkan semua pengguna di kolom isi pelanggan multi-domain." |
customer |
ID yang tidak dapat diubah dari akun Google Workspace. Jika ada beberapa domain, untuk mengambil semua pengguna bagi pelanggan, isi kolom ini, bukan domain. |
event |
Peristiwa yang akan dipantau. |
customFieldMask |
Daftar nama skema yang dipisahkan koma. Semua kolom dari skema ini diambil. Kolom ini hanya boleh ditetapkan jika projection=custom. |
maxResults |
Jumlah hasil maksimum yang akan ditampilkan. |
orderBy |
Kolom yang akan digunakan untuk mengurutkan hasil |
pageToken |
Token untuk menentukan halaman berikutnya dalam daftar |
projection |
Subkumpulan kolom yang akan diambil untuk pengguna ini. |
query |
Penelusuran string kueri. Harus dalam bentuk " |
showDeleted |
Jika disetel ke benar, akan mengambil daftar pengguna yang dihapus. (Default: false) |
sortOrder |
Apakah akan menampilkan hasil dalam urutan menaik atau menurun. |
viewType |
Apakah akan mengambil tampilan publik pengguna khusus administrator atau di seluruh domain. Untuk informasi selengkapnya, lihat Mengambil pengguna sebagai non-administrator. |
Isi permintaan
Isi permintaan memuat instance SubscriptionChannel
.
Isi respons
Jika berhasil, isi respons memuat instance SubscriptionChannel
.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
EventType
Jenis peristiwa Langganan
Enum | |
---|---|
ADD |
Peristiwa yang Dibuat Pengguna |
DELETE |
Peristiwa Penghapusan Pengguna |
MAKE_ADMIN |
Peristiwa Perubahan Status Admin Pengguna |
UNDELETE |
Peristiwa Penghapusan Pengguna Dibatalkan |
UPDATE |
Peristiwa Pengguna Diperbarui |
OrderBy
Enum | |
---|---|
EMAIL |
Email utama pengguna. |
FAMILY_NAME |
Nama belakang pengguna. |
GIVEN_NAME |
Nama depan pengguna. |
Proyeksi
Enum | |
---|---|
BASIC |
Jangan sertakan kolom kustom apa pun untuk pengguna. |
CUSTOM |
Sertakan kolom kustom dari skema yang disebutkan di customFieldMask. |
FULL |
Sertakan semua kolom yang terkait dengan pengguna ini. |
SortOrder
Enum | |
---|---|
ASCENDING |
Urutan menaik. |
DESCENDING |
Urutan menurun. |
ViewType
Enum | |
---|---|
admin_view |
Hasilnya mencakup kolom khusus administrator dan kolom publik domain. |
domain_public |
Hasil hanya menyertakan kolom untuk pengguna yang terlihat secara publik oleh pengguna lain di domain. |