Method: users.get

Mengambil pengguna.

Permintaan HTTP

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userKey

string

Mengidentifikasi pengguna dalam permintaan API. Nilainya dapat berupa alamat email utama, alamat email alias, atau ID pengguna unik.

Parameter kueri

Parameter
customFieldMask

string

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

projection

enum (Projection)

Subkumpulan kolom yang harus diambil untuk pengguna ini.

viewType

enum (ViewType)

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance User.

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Proyeksi

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

JenisTampilan

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