Method: users.list

Mengambil daftar yang di-paging 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 diambil. Kolom ini hanya boleh ditetapkan jika projection=custom.
customer

string

ID unik untuk akun Google Workspace pelanggan. Jika akun memiliki beberapa domain, gunakan kolom ini, bukan domain, untuk mengambil semua pengguna bagi pelanggan. Anda juga dapat menggunakan alias my_customer untuk mewakili customerId akun Anda. customerId juga ditampilkan sebagai bagian dari resource Pengguna. Anda harus memberikan parameter customer atau domain.
domain

string

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

enum (Event)

Peristiwa yang menjadi tujuan 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. Token halaman hanya valid selama tiga hari.
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 disetel ke true, akan mengambil daftar pengguna yang dihapus. (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 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

Jenis resource ini.
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. Token halaman hanya valid selama tiga hari.

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.

Acara

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 diminta 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 untuk pengguna.
domain_public Hasil hanya menyertakan kolom untuk pengguna yang terlihat secara publik oleh pengguna lain di domain.