Referensi: Pengguna
Directory API memungkinkan Anda membuat dan mengelola pengguna, alias pengguna, dan foto profil Google milik akun Anda. Untuk informasi selengkapnya tentang tugas umum, lihat Panduan Developer Akun Pengguna dan Panduan Developer Alias Pengguna.
Representasi JSON |
---|
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
object ( |
Kolom | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
ID unik untuk pengguna. |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
Alamat email primer pengguna. Properti ini diperlukan dalam permintaan untuk membuat akun pengguna. |
||||||||||||||||||||||||||||||||||||||||||
password |
Menyimpan sandi untuk akun pengguna. Nilai sandi pengguna wajib diisi saat membuat akun pengguna. Atribut ini bersifat opsional saat memperbarui pengguna dan hanya diberikan jika pengguna memperbarui sandi akunnya. Nilai sandi tidak pernah ditampilkan dalam isi respons API. |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
Menyimpan format hash properti
Jika bilangan bulat ditentukan sebagai bagian dari awalan, bilangan bulat tersebut harus berjumlah 10.000 atau kurang. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
Hanya output. Menunjukkan pengguna dengan hak istimewa administrator super. Properti |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
Hanya output. Menunjukkan apakah pengguna adalah administrator yang didelegasikan. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
Hanya output. Properti ini adalah |
||||||||||||||||||||||||||||||||||||||||||
suspended |
Menunjukkan apakah pengguna ditangguhkan. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
Menunjukkan jika pengguna dipaksa untuk mengubah sandi pada login berikutnya. Setelan ini tidak berlaku jika pengguna login melalui penyedia identitas pihak ketiga. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
Jika |
||||||||||||||||||||||||||||||||||||||||||
name |
Menyimpan nama depan dan nama keluarga pengguna, serta nilai |
||||||||||||||||||||||||||||||||||||||||||
kind |
Hanya output. Jenis resource API. Untuk resource Pengguna, nilainya adalah |
||||||||||||||||||||||||||||||||||||||||||
etag |
Hanya output. ETag resource. |
||||||||||||||||||||||||||||||||||||||||||
emails |
Daftar alamat email pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
Daftar ID eksternal untuk pengguna, seperti ID karyawan atau jaringan. Ukuran data maksimum yang diizinkan adalah 2 KB.
|
||||||||||||||||||||||||||||||||||||||||||
relations |
Daftar hubungan pengguna dengan pengguna lain. Ukuran data maksimum yang diizinkan untuk kolom ini adalah 2 KB. Untuk informasi selengkapnya, lihat Mengelola akun pengguna.
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
Hanya output. Daftar alamat email alias pengguna. |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
Hanya output. Menunjukkan apakah kotak surat Google pengguna dibuat. Properti ini hanya berlaku jika pengguna telah diberi lisensi Gmail. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
Hanya output. ID pelanggan untuk mengambil semua pengguna akun. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
Daftar alamat pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
Daftar organisasi tempat pengguna berada. Ukuran data maksimum yang diizinkan adalah 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
Hanya output. Terakhir kali pengguna login ke akun pengguna. Nilai menggunakan format tanggal dan waktu ISO 8601. Waktu adalah tanggal lengkap plus jam, menit, dan detik dalam format |
||||||||||||||||||||||||||||||||||||||||||
phones |
Daftar nomor telepon pengguna. Ukuran data maksimum yang diizinkan adalah 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
Hanya output. Memiliki alasan akun pengguna ditangguhkan, baik oleh administrator atau oleh Google pada saat penangguhan. Properti hanya ditampilkan jika properti |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
Hanya output. URL foto profil pengguna. URL mungkin bersifat sementara atau pribadi. |
||||||||||||||||||||||||||||||||||||||||||
languages |
Daftar bahasa pengguna. Ukuran data maksimum yang diizinkan adalah 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
Daftar informasi akun POSIX untuk pengguna.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
Hanya output. Waktu pembuatan akun pengguna. Nilai menggunakan format tanggal dan waktu ISO 8601. Waktu adalah tanggal lengkap plus jam, menit, dan detik dalam format |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
Hanya output. Daftar alamat email alias pengguna yang tidak dapat diedit. URL ini biasanya berada di luar domain primer atau subdomain akun. |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
Daftar kunci publik SSH.
|
||||||||||||||||||||||||||||||||||||||||||
notes |
Catatan untuk pengguna sebagai objek bertingkat.
|
||||||||||||||||||||||||||||||||||||||||||
websites |
Daftar situs pengguna.
|
||||||||||||||||||||||||||||||||||||||||||
locations |
Daftar lokasi pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
Menunjukkan apakah profil pengguna terlihat dalam daftar alamat global Google Workspace saat fitur berbagi kontak diaktifkan untuk domain. Untuk informasi selengkapnya tentang mengecualikan profil pengguna, lihat pusat bantuan administrasi. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
Daftar kata kunci pengguna. Ukuran data maksimum yang diizinkan adalah 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
Hanya output. Waktu akun pengguna dihapus. Nilai menggunakan format tanggal dan waktu ISO 8601. Waktu adalah tanggal lengkap plus jam, menit, dan detik dalam format |
||||||||||||||||||||||||||||||||||||||||||
gender |
Objek bertingkat yang berisi gender pengguna. Ukuran data maksimum yang diizinkan untuk kolom ini adalah 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
Hanya output. ETag foto pengguna (Hanya baca) |
||||||||||||||||||||||||||||||||||||||||||
ims |
Akun Instant Messenger (IM) pengguna. Akun pengguna dapat memiliki beberapa properti
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
Kolom kustom pengguna. Kuncinya adalah
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
Hanya output. Terdaftar dalam verifikasi 2 langkah (Hanya baca) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
Hanya output. Apakah verifikasi 2 langkah diterapkan (Hanya baca) |
||||||||||||||||||||||||||||||||||||||||||
archived |
Menunjukkan apakah pengguna diarsipkan. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
Jalur lengkap organisasi induk yang terkait dengan pengguna. Jika organisasi induk adalah tingkat teratas, organisasi ini dilambangkan dengan garis miring ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
Email pemulihan pengguna. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
Nomor telepon pemulihan pengguna. Nomor telepon harus dalam format E.164, dimulai dengan tanda plus (+). Contoh: +16506661212. |
UserName
Representasi JSON |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
Kolom | |
---|---|
fullName |
Nama lengkap pengguna yang dibuat dengan menggabungkan nilai nama depan dan belakang. |
familyName |
Nama belakang pengguna. Diperlukan saat membuat akun pengguna. |
givenName |
Nama depan pengguna. Diperlukan saat membuat akun pengguna. |
displayName |
Nama tampilan pengguna. Batas: 256 karakter. |
Metode |
|
---|---|
|
Menghapus pengguna. |
|
Mengambil pengguna. |
|
Membuat pengguna. |
|
Mengambil daftar pengguna yang telah dihapus atau semua pengguna di domain yang telah diberi nomor halaman. |
|
Membuat pengguna menjadi administrator super. |
|
Mengupdate pengguna menggunakan semantik patch. |
|
Membuat pengguna logout dari semua sesi web dan perangkat serta mereset cookie login mereka. |
|
Membatalkan penghapusan pengguna yang dihapus. |
|
Memperbarui pengguna. |
|
Mengamati perubahan dalam daftar pengguna. |