Method: users.get
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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 milik pengguna.
|
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.
|
projection |
enum (Projection)
Subkumpulan kolom yang akan diambil untuk pengguna ini.
|
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 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 mengetahui 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 kolom publik domain untuk pengguna. |
domain_public |
Hasil hanya menyertakan kolom untuk pengguna yang terlihat secara publik oleh pengguna lain di domain. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-25 UTC."],[],[],null,["Retrieves a user.\n\nHTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `userKey` | `string` Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |\n\nQuery parameters\n\n| Parameters ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customFieldMask` | `string` A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/users/get#Projection)`)` What subset of fields to fetch for this user. |\n| `viewType` | `enum (`[ViewType](/workspace/admin/directory/reference/rest/v1/users/get#ViewType)`)` Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains an instance of [User](/workspace/admin/directory/reference/rest/v1/users#User).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nProjection\n\n| Enums ||\n|----------|--------------------------------------------------------------------|\n| `BASIC` | Do not include any custom fields for the user. |\n| `CUSTOM` | Include custom fields from schemas requested in `customFieldMask`. |\n| `FULL` | Include all fields associated with this user. |\n\nViewType\n\n| Enums ||\n|-----------------|--------------------------------------------------------------------------------------------------|\n| `admin_view` | Results include both administrator-only and domain-public fields for the user. |\n| `domain_public` | Results only include fields for the user that are publicly visible to other users in the domain. |"]]
