Method: users.watch

Mengawasi 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

string

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

customer

string

ID akun Google Workspace yang tidak dapat diubah. Dalam kasus multi-domain, isi kolom ini, bukan domain, untuk mengambil semua pengguna untuk pelanggan.

event

enum (EventType)

Acara untuk ditonton.

customFieldMask

string

Daftar nama skema yang dipisahkan koma. Semua kolom dari skema ini diambil. Kolom ini hanya boleh disetel 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)

Subset kolom yang akan diambil untuk pengguna ini.

query

string

Penelusuran string kueri. Harus dalam format "". Dokumentasi lengkap tersedia di https: //developers.google.com/admin-sdk/directory/v1/guides/search-users

showDeleted

string

Jika disetel ke benar (true), daftar pengguna yang dihapus akan diambil. (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 informasi selengkapnya, lihat Mengambil pengguna sebagai non-administrator.

Isi permintaan

Isi permintaan memuat instance SubscriptionChannel.

Isi respons

Jika berhasil, isi respons akan berisi 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 informasi selengkapnya, lihat Panduan otorisasi.

EventType

Jenis acara Langganan

Enum
ADD Peristiwa Buatan Pengguna
DELETE Peristiwa yang Dihapus Pengguna
MAKE_ADMIN Peristiwa Perubahan Status Admin Pengguna
UNDELETE Peristiwa Penghapusan Pengguna Dibatalkan
UPDATE Peristiwa Pembaruan Pengguna

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 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 domain-publik.
domain_public Hasilnya hanya menyertakan kolom untuk pengguna yang dapat dilihat secara publik oleh pengguna lain di domain tersebut.