REST Resource: users

Kaynak: Kullanıcı

Directory API, hesabınızın kullanıcılarını, kullanıcı takma adlarını ve kullanıcı Google profil fotoğraflarını oluşturup yönetmenize olanak tanır. Genel görevler hakkında daha fazla bilgi için Kullanıcı Hesapları Geliştirici Kılavuzu'na ve Kullanıcı Takma Adları Geliştirici Kılavuzu'na bakın.

JSON gösterimi

{ "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 }

Alanlar
id	string Kullanıcının benzersiz kimliği. id kullanıcısı, kullanıcı istek URI'sının userKey'i olarak kullanılabilir.
primaryEmail	string Kullanıcının birincil e-posta adresi. Bu özellik, kullanıcı hesabı oluşturma isteklerinde gereklidir. primaryEmail benzersiz olmalıdır ve başka bir kullanıcının takma adı olamaz.
password	value (Value format) Kullanıcı hesabının şifresini depolar. Kullanıcı hesabı oluştururken kullanıcı şifresi değeri gereklidir. Bir kullanıcı güncellenirken isteğe bağlıdır ve yalnızca kullanıcı hesap şifresini güncelliyorsa sağlanmalıdır. Şifre değeri, API'nin yanıt gövdesinde hiçbir zaman döndürülmez. Şifre 8-100 karakter uzunluğunda olmalıdır ve ASCII karakterlerden oluşan herhangi bir kombinasyon içerebilir. password parametresini on altılı olarak kodlanmış karma değeri olarak göndermenizi ve hashFunction buna göre ayarlamanızı öneririz. hashFunction belirtilirse şifrenin geçerli bir karma anahtarı olması gerekir.
hashFunction	string password özelliğinin karma biçimini depolar. Şu hashFunction değerlerine izin verilir: MD5 - Basit onaltılık kodlanmış değerleri kabul eder. SHA-1 - Basit onaltılık kodlanmış değerleri kabul eder. crypt - C şifreleme kitaplığıyla uyumludur. DES, MD5 (karma ön eki $1$), SHA-256 (karma ön eki $5$) ve SHA-512 (karma ön eki $6$) karma algoritmalarını destekler. Tur sayısı önekin bir parçası olarak belirtilirse, 10.000 veya daha az olmalıdır.
isAdmin	boolean Yalnızca çıkış. Süper yönetici ayrıcalıklarına sahip bir kullanıcıyı belirtir. isAdmin özelliği yalnızca Bir kullanıcıyı yönetici yapma işleminde ( makeAdmin yöntemi) düzenlenebilir. Kullanıcı insert veya update yöntemlerinde düzenlenirse bu düzenleme, API hizmeti tarafından yoksayılır.
isDelegatedAdmin	boolean Yalnızca çıkış. Kullanıcının yetki verilmiş bir yönetici olup olmadığını belirtir. Yetki verilmiş yöneticiler API tarafından desteklenir ancak kullanıcı oluşturamaz, silme işlemini geri alamaz veya kullanıcıları yönetici yapamaz. Bu istekler API hizmeti tarafından yoksayılır. Yöneticilere ilişkin roller ve ayrıcalıklar Yönetici Konsolu kullanılarak atanır.
agreedToTerms	boolean Yalnızca çıkış. Kullanıcı, ilk giriş işlemini tamamlayıp Hizmet Şartları sözleşmesini kabul ettiyse bu mülk true şeklindedir.
suspended	boolean Kullanıcının askıya alınıp alınmadığını belirtir.
changePasswordAtNextLogin	boolean Kullanıcının bir sonraki girişte şifresini değiştirmeye zorlanıp zorlanmadığını belirtir. Kullanıcı üçüncü taraf bir kimlik sağlayıcı üzerinden oturum açtığında bu ayar geçerli olmaz.
ipWhitelisted	boolean true ise kullanıcının IP adresi, kullanımdan kaldırılmış bir IP adresi allowlist yapılandırmasına tabi olur.
name	object (UserName) Kullanıcının verilen adı ile soyadını ve salt okunur fullName değerini barındırır. givenName ve familyName değerlerinde maksimum karakter sayısı 60'tır. Ayrıca, ad değerleri unicode/UTF-8 karakterleri destekler ve boşluk, harf (a-z), rakam (0-9), kısa çizgi (-), eğik çizgi (/) ve nokta (.) içerebilir. Karakter kullanım kuralları hakkında daha fazla bilgi için yönetim yardım merkezine göz atın. Bu alan için izin verilen maksimum veri boyutu 1 KB'tır.
kind	string Yalnızca çıkış. API kaynağının türü. Kullanıcı kaynakları için değer admin#directory#user şeklindedir.
etag	string Yalnızca çıkış. Kaynağın ETag.
emails	value (Value format) Kullanıcının e-posta adreslerinin listesi. İzin verilen maksimum veri boyutu 10 KB'tır. Alanlar emails[].address string Kullanıcının e-posta adresi. Ayrıca e-posta kimliği görevi de görür. Bu değer, kullanıcının birincil e-posta adresi veya bir takma ad olabilir. emails[].customType string type e-posta adresi custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. emails[].primary boolean Bunun kullanıcının birincil e-posta adresi olup olmadığını belirtir. Yalnızca bir giriş birincil olarak işaretlenebilir. emails[].type string E-posta hesabının türü. custom olarak ayarlanırsa customType politikası da ayarlanmalıdır. Kabul edilebilir değerler: custom, home, other, work.
externalIds	value (Value format) Kullanıcıya ait harici kimliklerin listesi (çalışan veya ağ kimliği gibi). İzin verilen maksimum veri boyutu 2 KB'tır. Alanlar externalIds[].customType string Harici kimlik type, custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. externalIds[].type string Harici kimliğin türü. custom olarak ayarlanırsa customType de ayarlanmalıdır. Kabul edilebilir değerler: account, custom, customer, login_id, network, organization. externalIds[].value string Harici kimliğin değeri.
relations	value (Value format) Kullanıcının diğer kullanıcılarla olan ilişkilerinin listesi. Bu alan için izin verilen maksimum veri boyutu 2 KB'tır. Daha fazla bilgi için Kullanıcı hesaplarını yönetme başlıklı makaleyi inceleyin. Alanlar relations[].customType string type ilişkisi custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. relations[].type string İlişkinin türü. custom olarak ayarlanırsa customType de ayarlanmalıdır. Kabul edilebilir değerler: 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 Kullanıcıyla ilişkili kişinin e-posta adresi.
aliases[]	string Yalnızca çıkış. Kullanıcının takma ad e-posta adreslerinin listesi.
isMailboxSetup	boolean Yalnızca çıkış. Kullanıcının Google posta kutusunun oluşturulup oluşturulmadığını belirtir. Bu özellik yalnızca kullanıcıya bir Gmail lisansı atanmışsa kullanılabilir.
customerId	string Yalnızca çıkış. Tüm hesap kullanıcılarını almak için kullanılan müşteri kimliği. Hesabınızdaki customerId adlı kullanıcıyı temsil etmek için my_customer takma adını kullanabilirsiniz. Bayi yöneticisi olarak, yeniden satış yapılan müşteri hesabının customerId adresini kullanabilirsiniz. customerId almak için hesabın birincil alanını users.list isteğinin domain parametresinde kullanın.
addresses	value (Value format) Kullanıcının adreslerinin listesi. İzin verilen maksimum veri boyutu 10 KB'tır. Alanlar addresses[].country string Ülke. addresses[].countryCode string Ülke kodu. ISO 3166-1 standardını kullanır. addresses[].customType string type adresi custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. addresses[].extendedAddress string Alt bölge içeren bir adres gibi genişletilmiş adresler için. addresses[].formatted string Tam ve yapılandırılmamış posta adresi. Bu, yapılandırılmış adres alanlarıyla senkronize edilmez. Şu özellikleri içerir: açık adres, posta kutusu, şehir, eyalet/il, posta kodu, ülke/bölge. addresses[].locality string Adresin bulunduğu ilçe. addresses[].poBox string Varsa posta kutusu. addresses[].postalCode string Varsa posta kodu. addresses[].primary boolean Bu, kullanıcının birincil adresiyse. Adres listesi yalnızca bir birincil adres içerebilir. addresses[].region string Kısaltılmış il veya eyalet. addresses[].sourceIsStructured boolean Kullanıcı tarafından sağlanan adresin biçimlendirilip biçimlendirilmediğini belirtir. Biçimlendirilmiş adresler şu anda desteklenmemektedir. addresses[].streetAddress string Açık adres (ör. 1600 Amphitheatre Parkway). Dize içindeki boşluk yok sayılır ancak yeni satırlar anlamlıdır. addresses[].type string Adres türü. custom olarak ayarlanırsa customType politikası da ayarlanmalıdır. Kabul edilebilir değerler: custom, home, other, work.
organizations	value (Value format) Kullanıcının ait olduğu kuruluşların listesi. İzin verilen maksimum veri boyutu 10 KB'tır. Alanlar organizations[].costCenter string Kullanıcının kuruluşunun maliyet merkezi. organizations[].customType string Tür değeri özelse bu özellik özel türü içerir. organizations[].department string Kuruluştaki departmanı belirtir (örneğin, sales veya engineering). organizations[].description string Kuruluşun açıklaması. organizations[].domain string Kuruluşun ait olduğu alan. organizations[].fullTimeEquivalent integer Kuruluştaki tam zamanlı eşdeğer binde birlik değer (100.000 = %100). organizations[].location string Kurumun fiziksel konumu. Bunun tam olarak uygun bir adres olması gerekmez. organizations[].name string Kurumun adı. organizations[].primary boolean Bunun, kullanıcının birincil kuruluşu olup olmadığını belirtir. Bir kullanıcının yalnızca bir tane birincil kuruluşu olabilir. organizations[].symbol string Kuruluşun metin dizesi simgesi. Örneğin, Google'ın metin simgesi GOOG'dir. organizations[].title string Kullanıcının kuruluştaki unvanı. Örneğin, member veya engineer. organizations[].type string Kuruluşun türü. Kabul edilebilir değerler: domain_only, school, unknown, work.
lastLoginTime	string Yalnızca çıkış. Kullanıcının, hesabına en son giriş zamanı. Bu değer, ISO 8601 tarih ve saat biçimindedir. Saat, tam tarihin yanı sıra YYYY-MM-DDThh:mm:ssTZD biçiminde saat, dakika ve saniye şeklindedir. Örneğin, 2010-04-05T17:30:04+01:00.
phones	value (Value format) Kullanıcının telefon numaralarının listesi. İzin verilen maksimum veri boyutu 1 KB'tır. Alanlar phones[].customType string Telefon numarası type custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. phones[].primary boolean true ise bu, kullanıcının birincil telefon numarasıdır. Bir kullanıcının yalnızca bir tane birincil telefon numarası olabilir. phones[].type string Telefon numarasının türü. custom olarak ayarlanırsa customType de ayarlanmalıdır. Kabul edilebilir değerler: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, , , tty_tdd, tty_tddworkwork_faxwork_mobilework_pager phones[].value string Okunabilir bir telefon numarası. Herhangi bir telefon numarası biçiminde olabilir.
suspensionReason	string Yalnızca çıkış. Askıya alma sırasında bir kullanıcı hesabının yönetici veya Google tarafından askıya alınmasının nedenini içerir. Özellik yalnızca suspended özelliği true ise döndürülür.
thumbnailPhotoUrl	string Yalnızca çıkış. Kullanıcının profil fotoğrafının URL'si. URL geçici veya özel olabilir.
languages	value (Value format) Kullanıcının diller listesi. İzin verilen maksimum veri boyutu 1 KB'tır. Alanlar languages[].customLanguage string Diğer dil. İlgili ISO 639 dil kodu yoksa kullanıcı kendi dil adını sağlayabilir. Bu ayarlanırsa languageCode ayarlanamaz. languages[].languageCode string Bir dilin ISO 639 dize gösterimi. Desteklenen kodların listesi için Dil Kodları'na bakın. Desteklenen grubun dışındaki geçerli dil kodları, API tarafından kabul edilir ancak beklenmedik davranışlara neden olabilir. Geçersiz değerler SchemaException sorununa neden oluyor. Bu ayarlanırsa customLanguage ayarlanamaz. languages[].preference string İsteğe bağlı. Varsa belirtilen languageCode dilinin kullanıcının tercih ettiği dil olup olmadığını kontrol eder. customLanguage ayarlanırsa bu ayarlanamaz. preferred ve not_preferred değerlerine izin verilir.
posixAccounts	value (Value format) Kullanıcının POSIX hesap bilgilerinin listesi. Alanlar posixAccounts[].accountId string Bir POSIX hesap alanı tanımlayıcısı. posixAccounts[].gecos string Bu hesabın GECOS (kullanıcı bilgileri). posixAccounts[].gid unsigned long Varsayılan grup kimliği. posixAccounts[].homeDirectory string Bu hesabın ana dizininin yolu. posixAccounts[].operatingSystemType string Bu hesabın işletim sistemi türü. Kabul edilebilir değerler: linux, unspecified, windows. posixAccounts[].primary boolean Bu, kullanıcının SystemId içindeki birincil hesabıysa. posixAccounts[].shell string Bu hesaba ait giriş kabuğunun yolu. posixAccounts[].systemId string Kullanıcı adı veya kullanıcı kimliğinin geçerli olduğu sistem tanımlayıcısı. posixAccounts[].uid unsigned long POSIX uyumlu kullanıcı kimliği. posixAccounts[].username string Hesabın kullanıcı adı.
creationTime	string Yalnızca çıkış. Kullanıcının hesabının oluşturulduğu zaman. Bu değer, ISO 8601 tarih ve saat biçimindedir. Saat, tam tarihin yanı sıra YYYY-MM-DDThh:mm:ssTZD biçiminde saat, dakika ve saniye şeklindedir. Örneğin, 2010-04-05T17:30:04+01:00.
nonEditableAliases[]	string Yalnızca çıkış. Kullanıcının düzenlenemeyen takma ad e-posta adreslerinin listesi. Bunlar genellikle hesabın birincil alanının veya alt alanının dışındadır.
sshPublicKeys	value (Value format) SSH ortak anahtarlarının listesi. Alanlar sshPublicKeys[].expirationTimeUsec long Dönemden bu yana geçen, mikrosaniye cinsinden geçerlilik süresi. sshPublicKeys[].fingerprint string SSH ortak anahtarının SHA-256 parmak izi. (Salt okunur) sshPublicKeys[].key string SSH ortak anahtarı.
notes	value (Value format) İç içe yerleştirilmiş nesne olarak kullanıcı için notlar. Alanlar notes.contentType string Notun içerik türü (düz metin veya HTML). Varsayılan değer düz metindir. Kabul edilebilir değerler: text_plain, text_html. notes.value string Notların içeriği.
websites	value (Value format) Kullanıcının web sitelerinin listesi. Alanlar websites[].customType string type web sitesi custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. websites[].primary boolean true ise bu, kullanıcının birincil web sitesidir. websites[].type string Web sitesinin türü veya amacı. Örneğin, bir web sitesi home veya blog olarak etiketlenebilir. Alternatif olarak, bir girişin custom türü de olabilir. custom olarak ayarlanırsa customType de ayarlanmalıdır. Kabul edilebilir değerler: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work. websites[].value string Web sitesinin URL'si.
locations	value (Value format) Kullanıcının konumlarının listesi. İzin verilen maksimum veri boyutu 10 KB'tır. Alanlar locations[].area string Metin konumu. Konumu kısa ve öz bir şekilde açıklamak amacıyla görüntüleme amaçları için bu en çok işe yarar. Örneğin, Mountain View, CA veya Near Seattle. locations[].buildingId string Bina tanımlayıcısı. locations[].customType string type konumu custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. locations[].deskCode string Ayrı masa konumunun en belirgin metin kodu. locations[].floorName string Kat adı/numarası. locations[].floorSection string Kat bölümü. Kattaki daha belirli bir konum. Örneğin bir taban fiyat A, B ve C bölümlerine bölünmüşse bu alan, bu değerlerden birini tanımlar. locations[].type string Konum türü. custom olarak ayarlanırsa customType politikası da ayarlanmalıdır. Kabul edilebilir değerler: custom, default, desk.
includeInGlobalAddressList	boolean Kişi paylaşımı özelliği alan için etkinleştirildiğinde kullanıcı profilinin Google Workspace genel adres listesinde görünüp görünmediğini belirtir. Kullanıcı profillerini hariç tutma hakkında daha fazla bilgi edinmek için yönetim yardım merkezine göz atın.
keywords	value (Value format) Kullanıcının anahtar kelime listesi. İzin verilen maksimum veri boyutu 1 KB'tır. Alanlar keywords[].customType string type anahtar kelimesi custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. keywords[].type string Her girişin, bu girişin standart türünü gösteren bir türü olabilir. Örneğin, anahtar kelime occupation veya outlook türünde olabilir. Standart türe ek olarak, bir giriş custom türüne sahip olabilir ve bu girişe herhangi bir ad verebilir. custom olarak ayarlanırsa customType politikası da ayarlanmalıdır. Kabul edilebilir değerler: custom, mission, occupation, outlook. keywords[].value string Anahtar kelime.
deletionTime	string Yalnızca çıkış. Kullanıcının hesabının silindiği zaman. Bu değer, ISO 8601 tarih ve saat biçimindedir. Saat, tam tarihin yanı sıra YYYY-MM-DDThh:mm:ssTZD biçiminde saat, dakika ve saniye şeklindedir. Örneğin, 2010-04-05T17:30:04+01:00.
gender	value (Value format) Kullanıcının cinsiyetini içeren iç içe yerleştirilmiş bir nesne. Bu alan için izin verilen maksimum veri boyutu 1 KB'tır. Alanlar gender.addressMeAs string İnsanların profil sahibine atıfta bulunmanın uygun yolunu (örneğin, "he/on/onlar" veya "onlar/onlar/onlar" gibi) içeren, kullanıcıların okuyabileceği bir dize. gender.customGender string Özel bir cinsiyetin adı. gender.type string Cinsiyetin türü. Kabul edilebilir değerler: female male other unknown
thumbnailPhotoEtag	string Yalnızca çıkış. Kullanıcı fotoğrafının ETag (Salt okunur)
ims	value (Value format) Kullanıcının Instant Messenger (IM) hesapları. Bir kullanıcı hesabının birden fazla ims mülkü olabilir, ancak bu ims özelliklerinden yalnızca biri birincil IM kişisi olabilir. Alanlar ims[].customProtocol string Protokol değeri custom_protocol ise bu özellik, özel protokolün dizesini içerir. ims[].customType string IM type custom ise bu özellik özel değeri içerir ve ayarlanmalıdır. ims[].im string Kullanıcının IM ağ kimliği. ims[].primary boolean Bu, kullanıcının birincil IM'siyse. IM listesinde yalnızca bir giriş için true (doğru) değeri olabilir. ims[].protocol string IM protokolü IM ağını tanımlar. Değer, özel ağ veya standart ağ olabilir. Kabul edilebilir değerler: aim: AOL Instant Messenger protokolü custom_protocol: Özel bir IM ağ protokolü gtalk: Google Talk protokolü icq: ICQ protokolü jabber: Jabber protokolü msn: MSN Messenger protokolü net_meeting: Net Toplantı protokolü qq: QQ protokolü skype: Skype protokolü yahoo: Yahoo Messenger protokolü ims[].type string IM hesabının türü. custom olarak ayarlanırsa customType politikası da ayarlanmalıdır. Kabul edilebilir değerler: custom, home, other, work.
customSchemas	value (Value format) Kullanıcının özel alanları. Anahtar bir schemaName ve değerleri 'fieldName': 'field_value'. customSchemas.(key), iç içe yerleştirilmiş bir nesne. customSchemas.(key).(key) herhangi bir değer olabilir.
isEnrolledIn2Sv	boolean Yalnızca çıkış. 2 adımlı doğrulamaya kayıtlı (Salt okunur)
isEnforcedIn2Sv	boolean Yalnızca çıkış. 2 adımlı doğrulama zorunlu kılınıyor mu (Salt okunur)
archived	boolean Kullanıcının arşivlenip arşivlenmediğini belirtir.
orgUnitPath	string Kullanıcıyla ilişkili üst kuruluşun tam yolu. Üst kuruluş en üst düzeyse öne eğik çizgiyle (/) gösterilir.
recoveryEmail	string Kullanıcının kurtarma e-postası.
recoveryPhone	string Kullanıcının kurtarma telefon numarası. Telefon numarası, artı işareti (+) ile başlayan E.164 biçiminde olmalıdır. Örnek: [phone].

UserName

JSON gösterimi
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

Alanlar
fullName	string Kullanıcının ad ve soyadı değerlerinin birleştirilmesiyle oluşturulan tam adı.
familyName	string Kullanıcının soyadı. Kullanıcı hesabı oluştururken gerekir.
givenName	string Kullanıcının adı. Kullanıcı hesabı oluştururken gerekir.
displayName	string Kullanıcının görünen adı. Sınır: 256 karakter.

Yöntemler
delete	Kullanıcıyı siler.
get	Bir kullanıcıyı getirir.
insert	Kullanıcı oluşturur.
list	Silinmiş kullanıcıların veya bir alandaki tüm kullanıcıların sayfalandırılmış bir listesini alır.
makeAdmin	Kullanıcıyı süper yönetici yapar.
patch	Yama semantiği kullanarak bir kullanıcıyı günceller.
signOut	Kullanıcının tüm web ve cihaz oturumlarını kapatır ve oturum açma çerezlerini sıfırlar.
undelete	Silinmiş bir kullanıcının silinmesini geri alır.
update	Bir kullanıcıyı günceller.
watch	Kullanıcı listesindeki değişiklikleri izler.