Method: users.list

Mengambil daftar yang diberi nomor halaman dari pengguna yang dihapus atau semua pengguna di domain.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
customFieldMask

string

Daftar nama skema yang dipisahkan koma. Semua kolom dari skema ini akan diambil. Ini hanya boleh disetel jika projection=custom.
customer

string

ID unik untuk akun Google Workspace pelanggan. Untuk akun multi-domain, untuk mengambil semua grup bagi pelanggan, gunakan kolom ini, bukan domain. Anda juga dapat menggunakan alias my_customer untuk mewakili customerId akun Anda. customerId juga ditampilkan sebagai bagian dari resource Users. Anda harus memberikan parameter customer atau domain.
domain

string

Nama domain. Gunakan kolom ini untuk mendapatkan grup dari satu domain saja. Untuk menampilkan semua domain untuk akun pelanggan, gunakan parameter kueri customer. Parameter customer atau domain harus diberikan.
event

enum (Event)

Peristiwa yang menjadi target langganan (jika berlangganan)
maxResults

integer

Jumlah hasil maksimum yang akan ditampilkan.
orderBy

enum (OrderBy)

Properti 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

String kueri untuk menelusuri kolom pengguna. Untuk informasi selengkapnya tentang cara membuat kueri pengguna, lihat Menelusuri Pengguna.
showDeleted

string

Jika ditetapkan ke true, daftar pengguna yang dihapus akan diambil. (Default: false)
sortOrder

enum (SortOrder)

Apakah akan menampilkan hasil dalam urutan menaik atau menurun, mengabaikan huruf besar/kecil.
viewType

enum (ViewType)

Apakah akan mengambil tampilan publik pengguna secara khusus administrator atau di seluruh domain. Untuk informasi selengkapnya, lihat Mengambil pengguna sebagai non-administrator.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Kolom
kind

string

Ini adalah jenis resource.
trigger_event

string

Peristiwa yang memicu respons ini (hanya digunakan dalam kasus Respons Push)
etag

string

ETag resource.
users[]

object (User)

Daftar objek pengguna.
nextPageToken

string

Token yang digunakan untuk mengakses halaman berikutnya dari hasil ini.

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.

Peristiwa

Jenis peristiwa Langganan

Enumerasi
ADD Acara Buatan Pengguna
DELETE Peristiwa yang Dihapus Pengguna
MAKE_ADMIN Peristiwa Perubahan Status Admin Pengguna
UNDELETE Peristiwa Pembatalan Penghapusan Pengguna
UPDATE Peristiwa yang Diperbarui Pengguna

PesanOleh

Enumerasi
EMAIL Email utama pengguna.
FAMILY_NAME Nama keluarga pengguna.
GIVEN_NAME Nama depan pengguna.

Projection

Enumerasi
BASIC Jangan sertakan kolom kustom untuk pengguna.
CUSTOM Sertakan kolom kustom dari skema yang diminta di customFieldMask.
FULL Sertakan semua kolom yang terkait dengan pengguna ini.

SortOrder

Enumerasi
ASCENDING Urutan naik.
DESCENDING Urutan menurun.

ViewType

Enumerasi
admin_view Hasilnya mencakup kolom khusus administrator dan kolom domain publik untuk pengguna.
domain_public Hasil hanya menyertakan kolom untuk pengguna yang dapat dilihat oleh pengguna lainnya di domain.