Method: users.watch

Memantau perubahan dalam daftar pengguna.

Permintaan HTTP

POST https://admin.googleapis.com/admin/directory/v1/users/watch

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
domain

string

Nama domain. Isi kolom ini untuk mendapatkan pengguna hanya dari domain ini. Untuk menampilkan semua pengguna, isi kolom pelanggan multi-domain."
customer

string

ID akun Google Workspace yang tidak dapat diubah. Jika ada beberapa domain, untuk mengambil semua pengguna pelanggan, isi kolom ini, bukan domain.
event

enum (EventType)

Acara yang perlu diperhatikan.
customFieldMask

string

Daftar nama skema yang dipisahkan koma. Semua kolom dari skema ini akan diambil. Kolom ini hanya boleh ditetapkan jika projection=custom.
maxResults

integer

Jumlah hasil maksimum yang akan ditampilkan.
orderBy

enum (OrderBy)

Kolom yang akan digunakan untuk mengurutkan hasil
pageToken

string

Token untuk menentukan halaman berikutnya dalam daftar
projection

enum (Projection)

Subkumpulan kolom yang akan diambil untuk pengguna ini.
query

string

Penelusuran string kueri. Berisi satu atau beberapa klausa penelusuran, yang masing-masing memiliki kolom, operator, dan nilai. Untuk dokumentasi lengkap, buka Menelusuri pengguna.
showDeleted

string

Jika disetel ke benar (true), mengambil daftar pengguna yang dihapus. (Default: false)
sortOrder

enum (SortOrder)

Apakah akan menampilkan hasil dalam urutan menaik atau menurun.
viewType

enum (ViewType)

Apakah akan mengambil tampilan publik khusus administrator atau seluruh domain pengguna. Untuk mengetahui 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 Pengguna Dihapus
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 Menyertakan kolom kustom dari skema yang disebutkan dalam customFieldMask.
FULL Sertakan semua kolom yang terkait dengan pengguna ini.

SortOrder

Enum
ASCENDING Urutan menaik.
DESCENDING Urutan menurun.

ViewType

Enum
admin_view Hasil mencakup kolom khusus administrator dan kolom publik domain.
domain_public Hasil hanya mencakup kolom untuk pengguna yang dapat dilihat secara publik oleh pengguna lain di domain.