REST Resource: users

Resource: Pengguna

Directory API memungkinkan Anda membuat dan mengelola pengguna akun, alias pengguna, dan foto profil Google pengguna. 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 (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string
}
Kolom
id

string

ID unik untuk pengguna. Pengguna id dapat digunakan sebagai userKey URI permintaan pengguna.
primaryEmail

string

Alamat email utama pengguna. Properti ini diperlukan dalam permintaan untuk membuat akun pengguna. primaryEmail harus unik dan tidak boleh menjadi alias dari pengguna lain.
password

value (Value format)

Menyimpan {i>password<i} untuk akun pengguna. Nilai sandi pengguna diperlukan saat membuat akun pengguna. Ini bersifat opsional saat memperbarui pengguna dan hanya boleh diberikan jika pengguna memperbarui sandi akun mereka. Nilai sandi tidak pernah ditampilkan dalam isi respons API.

Sandi dapat berisi kombinasi karakter ASCII, dan harus terdiri dari 8-100 karakter.

Sebaiknya kirim parameter password sebagai nilai hash berenkode heksadesimal dan tetapkan hashFunction sebagaimana mestinya. Jika hashFunction ditentukan, sandi harus berupa kunci hash yang valid.
hashFunction

string

Menyimpan format hash properti password. Nilai hashFunction berikut diizinkan:

  • MD5 - Menerima nilai berenkode heksadesimal sederhana.
  • SHA-1 - Menerima nilai berenkode heksadesimal sederhana.
  • crypt - Mematuhi library crypt C. Mendukung algoritma hash DES, MD5 (awalan hash $1$), SHA-256 (awalan hash $5$), dan SHA-512 (awalan hash $6$).

Jika putaran ditentukan sebagai bagian dari awalan, jumlah tersebut harus 10.000 atau kurang.
isAdmin

boolean

Hanya output. Menunjukkan pengguna dengan hak istimewa administrator super. Properti isAdmin hanya dapat diedit dalam operasi Jadikan pengguna sebagai administrator ( metode makeAdmin). Jika diedit dengan metode insert atau update pengguna, edit akan diabaikan oleh layanan API.
isDelegatedAdmin

boolean

Hanya output. Menunjukkan apakah pengguna adalah administrator yang didelegasikan.
Administrator yang didelegasikan didukung oleh API, tetapi tidak dapat membuat atau membatalkan penghapusan pengguna, atau menjadikan pengguna sebagai administrator. Permintaan ini diabaikan oleh layanan API.
Peran dan hak istimewa untuk administrator ditetapkan menggunakan konsol Admin.
agreedToTerms

boolean

Hanya output. Properti ini adalah true jika pengguna telah menyelesaikan login awal dan menyetujui perjanjian Persyaratan Layanan.
suspended

boolean

Menunjukkan apakah pengguna ditangguhkan.
changePasswordAtNextLogin

boolean

Menunjukkan jika pengguna dipaksa mengubah sandi pada login berikutnya. Setelan ini tidak berlaku jika pengguna login melalui penyedia identitas pihak ketiga.
ipWhitelisted

boolean

Jika true, alamat IP pengguna akan menggunakan konfigurasi alamat IP allowlist yang tidak digunakan lagi.
name

object (UserName)

Menyimpan nama tertentu dan nama keluarga pengguna, serta nilai fullName hanya baca. Jumlah karakter maksimum dalam nilai givenName dan familyName adalah 60. Selain itu, nilai nama mendukung karakter unicode/UTF-8, dan dapat berisi spasi, huruf (a-z), angka (0-9), tanda hubung (-), garis miring (/), dan titik (.). Untuk informasi selengkapnya tentang aturan penggunaan karakter, lihat pusat bantuan administrasi. Ukuran data maksimum yang diizinkan untuk kolom ini adalah 1 KB.
kind

string

Hanya output. Jenis resource API. Untuk resource Pengguna, nilainya adalah admin#directory#user.
etag

string

Hanya output. ETag resource.
emails

value (Value format)

Daftar alamat email pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.

Kolom

emails[].address

string

Alamat email pengguna. Juga berfungsi sebagai ID email. Nilai ini dapat berupa alamat email utama atau alias pengguna.

emails[].customType

string

Jika alamat email type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

emails[].primary

boolean

Menunjukkan apakah ini adalah email utama pengguna. Hanya satu entri yang dapat ditandai sebagai utama.

emails[].type

string

Jenis akun email. Jika ditetapkan ke custom, customType juga harus ditetapkan.

Nilai yang dapat diterima: custom, home, other, work.
externalIds

value (Value format)

Daftar ID eksternal untuk pengguna, seperti ID karyawan atau jaringan. Ukuran data maksimum yang diizinkan adalah 2 KB.

Kolom

externalIds[].customType

string

Jika ID eksternal type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

externalIds[].type

string

Jenis ID eksternal. Jika ditetapkan ke custom, customType juga harus ditetapkan.

Nilai yang dapat diterima: account, custom, customer, login_id, network, organization.

externalIds[].value

string

Nilai ID eksternal.
relations

value (Value format)

Daftar hubungan pengguna dengan pengguna lain. Ukuran data maksimum yang diizinkan untuk kolom ini adalah 2 KB. Untuk informasi selengkapnya, lihat Mengelola akun pengguna.

Kolom

relations[].customType

string

Jika hubungan type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

relations[].type

string

Jenis hubungan. Jika ditetapkan ke custom, customType juga harus ditetapkan.

Nilai yang dapat diterima:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

relations[].value

string

Alamat email pengguna yang terkait dengan pengguna.
aliases[]

string

Hanya output. Daftar alamat email alias pengguna.
isMailboxSetup

boolean

Hanya output. Menunjukkan apakah kotak surat Google pengguna telah dibuat. Properti ini hanya berlaku jika pengguna telah diberi lisensi Gmail.
customerId

string

Hanya output. ID pelanggan untuk mengambil semua pengguna akun.
Anda dapat menggunakan alias my_customer untuk mewakili customerId akun Anda.
Sebagai administrator reseller, Anda dapat menggunakan customerId akun pelanggan reseller. Untuk mendapatkan customerId, gunakan domain primer akun di parameter domain permintaan users.list.
addresses

value (Value format)

Daftar alamat pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.

Kolom

addresses[].country

string

Negara.

addresses[].countryCode

string

Kode negara. Menggunakan standar ISO 3166-1.

addresses[].customType

string

Jika alamat type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

addresses[].extendedAddress

string

Untuk alamat yang diperluas, seperti alamat yang mencakup subwilayah.

addresses[].formatted

string

Alamat pos yang lengkap dan tidak terstruktur. Ini tidak disinkronkan dengan kolom alamat terstruktur. Mencakup atribut berikut: alamat, P.O. box, kota, negara bagian/provinsi, kode pos, negara/wilayah.

addresses[].locality

string

Kota besar atau kota pada alamat.

addresses[].poBox

string

Kotak pos, jika ada.

addresses[].postalCode

string

Kode pos, jika berlaku.

addresses[].primary

boolean

Jika ini adalah alamat utama pengguna. Daftar alamat hanya dapat berisi satu alamat utama.

addresses[].region

string

Singkatan provinsi atau negara bagian.

addresses[].sourceIsStructured

boolean

Menunjukkan apakah alamat yang diberikan pengguna telah diformat. Alamat yang diformat saat ini tidak didukung.

addresses[].streetAddress

string

Alamat, seperti 1600 Amphitheatre Parkway. Spasi kosong dalam string diabaikan; namun, {i>newline<i} adalah hal yang signifikan.

addresses[].type

string

Jenis alamat. Jika ditetapkan ke custom, customType juga harus ditetapkan.

Nilai yang dapat diterima: custom, home, other, work.
organizations

value (Value format)

Daftar organisasi yang mencakup pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.

Kolom

organizations[].costCenter

string

Pusat biaya organisasi pengguna.

organizations[].customType

string

Jika nilai jenis adalah khusus, properti ini berisi jenis khusus.

organizations[].department

string

Menentukan departemen dalam organisasi, seperti sales atau engineering.

organizations[].description

string

Deskripsi organisasi.

organizations[].domain

string

Domain tempat organisasi berada.

organizations[].fullTimeEquivalent

integer

Milipersen setara purnawaktu dalam organisasi (100000 = 100%).

organizations[].location

string

Lokasi fisik organisasi. Alamat ini tidak harus berupa alamat yang sepenuhnya memenuhi syarat.

organizations[].name

string

Nama organisasi.

organizations[].primary

boolean

Menunjukkan apakah ini adalah organisasi utama pengguna. Pengguna hanya dapat memiliki satu organisasi utama.

organizations[].symbol

string

Simbol string teks organisasi. Misalnya, simbol teks untuk Google adalah GOOG.

organizations[].title

string

Jabatan pengguna dalam organisasi. Misalnya member atau engineer.

organizations[].type

string

Jenis organisasi.

Nilai yang dapat diterima: domain_only, school, unknown, work.
lastLoginTime

string

Hanya output. Terakhir kali pengguna login ke akun pengguna. Nilai ini dalam format tanggal dan waktu ISO 8601. Waktu adalah tanggal lengkap plus jam, menit, dan detik dalam bentuk YYYY-MM-DDThh:mm:ssTZD. Misalnya, 2010-04-05T17:30:04+01:00.
phones

value (Value format)

Daftar nomor telepon pengguna. Ukuran data maksimum yang diizinkan adalah 1 KB.

Kolom

phones[].customType

string

Jika nomor telepon type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

phones[].primary

boolean

Jika true, ini adalah nomor telepon utama pengguna. Pengguna hanya dapat memiliki satu nomor telepon utama.

phones[].type

string

Jenis nomor telepon. Jika disetel ke custom, customType juga harus disetel.

Nilai yang dapat diterima: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, {2/10/}.work_faxwork_mobilework_pager

phones[].value

string

Nomor telepon yang dapat dibaca manusia. Format ini dapat berupa nomor telepon apa pun.
suspensionReason

string

Hanya output. Memiliki alasan akun pengguna ditangguhkan oleh administrator atau Google pada saat penangguhan. Properti hanya ditampilkan jika properti suspended adalah true.
thumbnailPhotoUrl

string

Hanya output. URL foto profil pengguna. URL mungkin bersifat sementara atau pribadi.
languages

value (Value format)

Daftar bahasa pengguna. Ukuran data maksimum yang diizinkan adalah 1 KB.

Kolom

languages[].customLanguage

string

Bahasa lainnya. Pengguna dapat memberikan nama bahasanya sendiri jika tidak ada kode bahasa ISO 639 yang sesuai. Jika kebijakan ini disetel, languageCode tidak dapat disetel.

languages[].languageCode

string

Representasi string ISO 639 dari suatu bahasa. Lihat Kode Bahasa untuk melihat daftar kode yang didukung. Kode bahasa yang valid di luar rangkaian yang didukung akan diterima oleh API, tetapi dapat menyebabkan perilaku yang tidak terduga. Nilai ilegal menyebabkan SchemaException. Jika kebijakan ini disetel, customLanguage tidak dapat disetel.

languages[].preference

string

Opsional. Jika ada, kontrol apakah languageCode yang ditentukan merupakan bahasa pilihan pengguna. Jika customLanguage disetel, hal ini tidak dapat disetel. Nilai yang diizinkan adalah preferred dan not_preferred.
posixAccounts

value (Value format)

Daftar informasi akun POSIX untuk pengguna.

Kolom

posixAccounts[].accountId

string

ID kolom akun POSIX.

posixAccounts[].gecos

string

GECOS (informasi pengguna) untuk akun ini.

posixAccounts[].gid

unsigned long

ID grup default.

posixAccounts[].homeDirectory

string

Jalur ke direktori utama untuk akun ini.

posixAccounts[].operatingSystemType

string

Jenis sistem operasi untuk akun ini.

Nilai yang dapat diterima: linux, unspecified, windows.

posixAccounts[].primary

boolean

Jika ini adalah akun utama pengguna dalam SystemId.

posixAccounts[].shell

string

Jalur ke shell login untuk akun ini.

posixAccounts[].systemId

string

ID sistem tempat Nama Pengguna atau ID akun diterapkan.

posixAccounts[].uid

unsigned long

ID pengguna yang mematuhi POSIX.

posixAccounts[].username

string

Nama pengguna akun.
creationTime

string

Hanya output. Waktu pembuatan akun pengguna. Nilai ini dalam format tanggal dan waktu ISO 8601. Waktu adalah tanggal lengkap plus jam, menit, dan detik dalam bentuk YYYY-MM-DDThh:mm:ssTZD. Misalnya, 2010-04-05T17:30:04+01:00.
nonEditableAliases[]

string

Hanya output. Daftar alamat email alias pengguna yang tidak dapat diedit. Domain ini biasanya berada di luar domain primer akun atau subdomain.
sshPublicKeys

value (Value format)

Daftar kunci publik SSH.

Kolom

sshPublicKeys[].expirationTimeUsec

long

Waktu kedaluwarsa dalam mikrodetik sejak epoch.

sshPublicKeys[].fingerprint

string

Sidik jari SHA-256 dari kunci publik SSH. (Hanya baca)

sshPublicKeys[].key

string

Kunci publik SSH.
notes

value (Value format)

Catatan untuk pengguna sebagai objek bertingkat.

Kolom

notes.contentType

string

Jenis konten catatan, baik teks biasa atau HTML. Defaultnya adalah teks biasa.

Nilai yang dapat diterima: text_plain, text_html.

notes.value

string

Isi catatan.
websites

value (Value format)

Daftar situs pengguna.

Kolom

websites[].customType

string

Jika situs type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

websites[].primary

boolean

Jika true, situs ini adalah situs utama pengguna.

websites[].type

string

Jenis atau tujuan situs. Misalnya, situs dapat diberi label sebagai home atau blog. Atau, entri dapat memiliki jenis custom. Jika disetel ke custom, customType juga harus disetel.

Nilai yang dapat diterima: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work.

websites[].value

string

URL situs.
locations

value (Value format)

Daftar lokasi pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.

Kolom

locations[].area

string

Lokasi tekstual. Ini paling berguna untuk tujuan tampilan guna menggambarkan lokasi secara ringkas. Misalnya Mountain View, CA atau Near Seattle.

locations[].buildingId

string

ID gedung.

locations[].customType

string

Jika lokasi type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

locations[].deskCode

string

Kode tekstual paling spesifik untuk lokasi meja kerja individu.

locations[].floorName

string

Nama/nomor lantai.

locations[].floorSection

string

Bagian lantai. Lokasi yang lebih spesifik di dalam lantai. Misalnya, jika lantai dibagi menjadi bagian A, B, dan C, kolom ini akan mengidentifikasi salah satu nilai tersebut.

locations[].type

string

Jenis lokasi. Jika ditetapkan ke custom, customType juga harus ditetapkan.

Nilai yang dapat diterima: custom, default, desk.
includeInGlobalAddressList

boolean

Menunjukkan apakah profil pengguna terlihat di daftar alamat global Google Workspace saat fitur berbagi kontak diaktifkan untuk domain tersebut. Untuk informasi selengkapnya tentang cara mengecualikan profil pengguna, lihat pusat bantuan administrasi.
keywords

value (Value format)

Daftar kata kunci pengguna. Ukuran data maksimum yang diizinkan adalah 1 KB.

Kolom

keywords[].customType

string

Jika kata kunci type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

keywords[].type

string

Setiap entri dapat memiliki tipe yang menunjukkan tipe standar dari entri tersebut.

Misalnya, kata kunci dapat berjenis occupation atau outlook. Selain jenis standar, entri dapat memiliki jenis custom dan dapat memberinya nama apa pun. Jika ditetapkan ke custom, customType juga harus ditetapkan.

Nilai yang dapat diterima: custom, mission, occupation, outlook.

keywords[].value

string

Kata kunci.
deletionTime

string

Hanya output. Waktu akun pengguna dihapus. Nilai ini dalam format tanggal dan waktu ISO 8601. Waktu adalah tanggal lengkap plus jam, menit, dan detik dalam bentuk YYYY-MM-DDThh:mm:ssTZD. Contohnya, 2010-04-05T17:30:04+01:00.
gender

value (Value format)

Objek bertingkat yang berisi gender pengguna. Ukuran data maksimum yang diizinkan untuk kolom ini adalah 1 KB.

Kolom

gender.addressMeAs

string

String yang dapat dibaca manusia berisi cara yang tepat untuk merujuk pemilik profil oleh manusia, misalnya "dia/laki-laki/laki-laki" atau "mereka/mereka/mereka".

gender.customGender

string

Nama gender kustom.

gender.type

string

 Jenis gender.

Nilai yang dapat diterima:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

Hanya output. ETag foto pengguna (Hanya-baca)
ims

value (Value format)

Akun Instant Messenger (IM) pengguna. Akun pengguna dapat memiliki beberapa properti ims, tetapi hanya salah satu dari properti ims ini yang dapat menjadi kontak IM utama.

Kolom

ims[].customProtocol

string

Jika nilai protokol adalah custom_protocol, properti ini menyimpan string protokol kustom.

ims[].customType

string

Jika IM type adalah custom, properti ini berisi nilai kustom dan harus ditetapkan.

ims[].im

string

ID jaringan IM pengguna.

ims[].primary

boolean

Jika ini adalah IM utama pengguna. Hanya satu entri dalam daftar IM yang dapat memiliki nilai true.

ims[].protocol

string

 Protokol IM mengidentifikasi jaringan IM. Nilainya dapat berupa jaringan kustom atau jaringan standar.

Nilai yang dapat diterima:
  • aim: Protokol AOL Instant Messenger
  • custom_protocol: Protokol jaringan IM kustom
  • gtalk: Protokol Google Talk
  • icq: Protokol ICQ
  • jabber: Protokol Jabber
  • msn: Protokol MSN Messenger
  • net_meeting: Protokol Rapat Net
  • qq: Protokol QQ
  • skype: Protokol Skype
  • yahoo: Protokol Yahoo Messenger

ims[].type

string

Jenis akun IM. Jika ditetapkan ke custom, customType juga harus ditetapkan.

Nilai yang dapat diterima: custom, home, other, work.
customSchemas

value (Value format)

Kolom kustom pengguna. Kuncinya adalah schemaName dan nilainya adalah 'fieldName': 'field_value'.

  • customSchemas.(key) adalah objek bertingkat.
  • customSchemas.(key).(key) dapat berupa nilai berapa pun.
isEnrolledIn2Sv

boolean

Hanya output. Terdaftar di verifikasi 2 langkah (Hanya baca)
isEnforcedIn2Sv

boolean

Hanya output. Menerapkan verifikasi 2 langkah (Hanya baca)
archived

boolean

Menunjukkan apakah pengguna diarsipkan.
orgUnitPath

string

Jalur lengkap organisasi induk yang dikaitkan dengan pengguna. Jika organisasi induk adalah tingkat teratas, organisasi akan ditampilkan sebagai garis miring (/).
recoveryEmail

string

Email pemulihan pengguna.
recoveryPhone

string

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

string

Nama lengkap pengguna yang dibentuk dengan menggabungkan nilai nama depan dan nama belakang.
familyName

string

Nama belakang pengguna. Wajib saat membuat akun pengguna.
givenName

string

Nama depan pengguna. Wajib saat membuat akun pengguna.
displayName

string

Nama tampilan pengguna. Batas: 256 karakter.

Metode

delete

 Menghapus pengguna.

get

 Mengambil pengguna.

insert

 Membuat pengguna.

list

 Mengambil daftar pengguna yang dihapus atau semua pengguna di domain yang telah diberi nomor halaman.

makeAdmin

 Menjadikan pengguna sebagai administrator super.

patch

 Mengupdate pengguna menggunakan semantik patch.

signOut

 Membuat pengguna logout dari semua sesi web dan perangkat, serta mereset cookie login mereka.

undelete

 Membatalkan penghapusan pengguna yang dihapus.

update

 Memperbarui pengguna.

watch

 Mengawasi perubahan dalam daftar pengguna.