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 pengguna.

Parameter kueri

Parameter
customFieldMask

string

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

enum (Projection)

Subset kolom yang akan diambil untuk pengguna ini.
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 harus kosong.

Isi respons

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

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.

ViewType

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