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. Yaygın görevler hakkında daha fazla bilgi için Kullanıcı Hesapları Geliştirici Kılavuzu ve Kullanıcı Takma Adları Geliştirici Kılavuzu'na göz atı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. Kullanıcı istek URI'sinin userKey olarak bir kullanıcı id kullanılabilir.
primaryEmail

string

Kullanıcının birincil e-posta adresi. Bu mülk, kullanıcı hesabı oluşturma isteğinde gereklidir. primaryEmail benzersiz olmalı 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ının şifre değeri gereklidir. 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, ASCII karakterlerinin herhangi bir kombinasyonunu içerebilir ve 8-100 karakter uzunluğunda olmalıdır.

password parametresini onaltılık kodlu bir karma oluşturma değeri olarak göndermenizi ve hashFunction parametresini buna göre ayarlamanızı öneririz. hashFunction belirtilirse şifre geçerli bir karma anahtar olmalıdır.
hashFunction

string

password mülkünün karma oluşturma biçimini depolar. Aşağıdaki hashFunction değerlerine izin verilir:

  • MD5: Basit onaltılık kodlu değerleri kabul eder.
  • SHA-1: Basit onaltılık kodlu değerleri kabul eder.
  • crypt: C crypt kitaplığı ile uyumludur. DES, MD5 (karma ön ek $1$), SHA-256 (karma ön ek $5$) ve SHA-512 (karma ön ek $6$) karma oluşturma algoritmalarını destekler.

Ön ekin bir parçası olarak belirtilmişse tur sayısı en fazla 10.000 olmalıdır.
isAdmin

boolean

Yalnızca çıkış. Süper yönetici ayrıcalıklarına sahip bir kullanıcıyı belirtir. isAdmin mülkü yalnızca Kullanıcıyı yönetici yapma işleminde ( makeAdmin yöntemi) düzenlenebilir. Kullanıcı insert veya update yöntemlerinde düzenlenirse düzenleme API hizmeti tarafından yok sayılır.
isDelegatedAdmin

boolean

Yalnızca çıkış. Kullanıcının yetki verilmiş yönetici olup olmadığını belirtir.
Yetki verilmiş yöneticiler API tarafından desteklenir ancak kullanıcı oluşturamaz, kullanıcıları silebilir veya kullanıcıları yönetici yapamaz. Bu istekler API hizmeti tarafından yoksayılır.
Yöneticilere ait roller ve ayrıcalıklar Yönetici Konsolu kullanılarak atanır.
agreedToTerms

boolean

Yalnızca çıkış. Kullanıcı ilk oturumunu tamamlayıp Hizmet Şartları sözleşmesini kabul ettiyse bu özellik true olur.
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ştirmek zorunda olup olmadığını belirtir. Bu ayar, kullanıcı üçüncü taraf kimlik sağlayıcı üzerinden oturum açtığında geçerli olmaz.
ipWhitelisted

boolean

true ise kullanıcının IP adresi, desteği sonlandırılmış bir IP adresi allowlist yapılandırmasına tabidir.
name

object (UserName)

Kullanıcının adını, soyadını ve salt okunur fullName değerini içerir. givenName ve familyName değerlerinde maksimum karakter sayısı 60'tır. Ayrıca ad değerleri Unicode/UTF-8 karakterlerini 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 bakı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'tür.
etag

string

Yalnızca çıkış. Kaynağın ETag'i.
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. E-posta kimliği olarak da kullanılır. Bu değer, kullanıcının birincil e-posta adresi veya 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

Bu e-postanın kullanıcının birincil e-postası 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 da ayarlanmalıdır.

Kabul edilen değerler: custom, home, other, work.
externalIds

value (Value format)

Kullanıcının harici kimliklerinin listesi (ör. çalışan veya ağ kimliği). İ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 da ayarlanmalıdır.

Kabul edilen 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 da ayarlanmalıdır.

Kabul edilen 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ının akrabası olan 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 Gmail lisansı atanmışsa geçerlidir.
customerId

string

Yalnızca çıkış. Tüm hesap kullanıcılarını almak için müşteri kimliği.
Hesabınızın customerId değerini temsil etmek için my_customer takma adını kullanabilirsiniz.
Bayi yöneticisi olarak, yeniden satılan müşteri hesabının customerId değerini kullanabilirsiniz. customerId almak için users.list isteğinin domain parametresinde hesabın birincil alanını 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 adresler gibi genişletilmiş adresler için.

addresses[].formatted

string

Tam ve yapılandırılmamış bir posta adresi. Bu alan, yapılandırılmış adres alanlarıyla senkronize edilmez. Açık adres, posta kutusu, şehir, ilçe, posta kodu, ülke/bölge gibi özellikleri içerir.

addresses[].locality

string

Adresin bulunduğu kasaba veya şehir.

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şluklar yoksayılır ancak yeni satırlar önemlidir.

addresses[].type

string

Adres türü. custom olarak ayarlanırsa customType da ayarlanmalıdır.

Kabul edilen 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ğerinin özel olması durumunda bu özellik özel türü içerir.

organizations[].department

string

Kuruluştaki departmanı (ör. sales veya engineering) belirtir.

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 miliyüzde (100000 = %100).

organizations[].location

string

Kuruluşun fiziksel konumu. Bu adresin tam olarak tanımlanmış olması gerekmez.

organizations[].name

string

Kurumun adı.

organizations[].primary

boolean

Bu kuruluşun kullanıcının birincil kuruluşu olup olmadığını belirtir. Kullanıcıların yalnızca bir birincil kuruluşu olabilir.

organizations[].symbol

string

Kuruluşun metin dizesi simgesi. Örneğin, Google'ın metin simgesi GOOG şeklindedir.

organizations[].title

string

Kullanıcının kuruluştaki unvanı. Örneğin, member veya engineer.

organizations[].type

string

Kuruluşun türü.

Kabul edilen değerler: domain_only, school, unknown, work.
lastLoginTime

string

Yalnızca çıkış. Kullanıcının hesabına en son giriş yaptığı zaman. Değer, ISO 8601 tarih ve saat biçimindedir. Saat, YYYY-MM-DDThh:mm:ssTZD biçiminde tam tarih artı saat, dakika ve saniyedir. Ö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

type telefon numarası 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. Kullanıcıların yalnızca bir birincil telefon numarası olabilir.

phones[].type

string

Telefon numarasının türü. custom olarak ayarlanırsa customType da ayarlanmalıdır.

Kabul edilen değerler: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.

phones[].value

string

Kullanıcıların okuyabileceği bir telefon numarası. Telefon numarası herhangi bir biçimde olabilir.
suspensionReason

string

Yalnızca çıkış. Kullanıcı hesabının askıya alınmasının nedeni, askıya alma sırasında yönetici veya Google tarafından belirtilir. Ö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 gizli olabilir.
languages

value (Value format)

Kullanıcının dillerinin 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 ayar yapılırsa languageCode ayarlanamaz.

languages[].languageCode

string

Bir dilin ISO 639 dize temsili. Desteklenen kodların listesi için Dil Kodları bölümüne bakın. Desteklenen kümenin dışındaki geçerli dil kodları API tarafından kabul edilir ancak beklenmedik davranışlara neden olabilir. Geçersiz değerler SchemaException değerine neden olur. Bu ayar yapılırsa customLanguage ayarlanamaz.

languages[].preference

string

İsteğe bağlı. Varsa belirtilen languageCode değerinin kullanıcının tercih ettiği dil olup olmadığını kontrol eder. customLanguage ayarlanmışsa bu ayar yapılamaz. İzin verilen değerler preferred ve not_preferred'tır.
posixAccounts

value (Value format)

Kullanıcının POSIX hesap bilgilerinin listesi.

Alanlar

posixAccounts[].accountId

string

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 edilen değerler: linux, unspecified, windows.

posixAccounts[].primary

boolean

Bu, kullanıcının SystemId içindeki birincil hesabıysa.

posixAccounts[].shell

string

Bu hesabın giriş kabuğunun yolu.

posixAccounts[].systemId

string

Kullanıcı adı veya UID'nin geçerli olduğu hesap için sistem tanımlayıcısı.

posixAccounts[].uid

unsigned long

POSIX ile 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. Değer, ISO 8601 tarih ve saat biçimindedir. Saat, YYYY-MM-DDThh:mm:ssTZD biçiminde tam tarih artı saat, dakika ve saniyedir. Ö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 son kullanma zamanı.

sshPublicKeys[].fingerprint

string

SSH herkese açık anahtarının SHA-256 parmak izi. (Salt okunur)

sshPublicKeys[].key

string

SSH ortak anahtarı.
notes

value (Value format)

Kullanıcıya ait notlar, iç içe yerleştirilmiş nesne olarak.

Alanlar

notes.contentType

string

Notun içerik türü (düz metin veya HTML). Varsayılan ayar 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 mülk ö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, girişler custom türüne sahip olabilir. custom olarak ayarlanırsa customType da ayarlanmalıdır.

Kabul edilen 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 olarak konum. Konumun metin olarak girilmesi konumu açıkça tanımladığından, görüntüleme amaçları için en yararlı olanıdır. Ö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

Tek bir müşteri temsilcisi konumunun en belirgin metinsel kodu.

locations[].floorName

string

Kat adı/numarası.

locations[].floorSection

string

Kat bölümü. Kattaki daha spesifik konum. Örneğin, bir kat A, B ve C bölümlerine ayrılmışsa bu alan bu değerlerden birini tanımlar.

locations[].type

string

Konum türü. custom olarak ayarlanırsa customType da ayarlanmalıdır.

Kabul edilen değerler: custom, default, desk.
includeInGlobalAddressList

boolean

Alanda kişi paylaşımı özelliği etkinleştirildiğinde kullanıcının profilinin Google Workspace genel adres listesinde görünür olup olmadığını belirtir. Kullanıcı profillerini hariç tutma hakkında daha fazla bilgi için yönetim yardım merkezine göz atın.
keywords

value (Value format)

Kullanıcının anahtar kelimelerinin 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, o girişin standart türünü belirten bir türü olabilir.

Örneğin, anahtar kelime occupation veya outlook türü olabilir. Bir giriş, standart türe ek olarak custom türüne sahip olabilir ve bu türe herhangi bir ad verebilir. custom olarak ayarlanırsa customType da ayarlanmalıdır.

Kabul edilen 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. Değer, ISO 8601 tarih ve saat biçimindedir. Saat, YYYY-MM-DDThh:mm:ssTZD biçiminde tam tarih artı saat, dakika ve saniyedir. Ö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

Profil sahibinin gerçek kişiler tarafından doğru şekilde nasıl atıfta bulunulacağıyla ilgili bilgileri içeren, kullanıcıların okuyabileceği bir dize (ör. "o" veya "onlar").

gender.customGender

string

Özel cinsiyetin adı.

gender.type

string

 Cinsiyet türü.

Kabul edilebilir değerler:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

Yalnızca çıkış. Kullanıcının fotoğrafının ETag'i (Salt okunur)
ims

value (Value format)

Kullanıcının anlık mesajlaşma (IM) hesapları. Bir kullanıcı hesabının birden fazla ims mülkü olabilir ancak bu ims mülklerinden 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şin değeri doğru olabilir.

ims[].protocol

string

 IM protokolü, IM ağını tanımlar. Değer, özel bir 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 Meeting 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 da ayarlanmalıdır.

Kabul edilen 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 nesnedir.
  • customSchemas.(key).(key) herhangi bir değer olabilir.
isEnrolledIn2Sv

boolean

Yalnızca çıkış. 2 Adımlı Doğrulama'ya kayıtlı (Salt okunur)
isEnforcedIn2Sv

boolean

Yalnızca çıkış. 2 Adımlı Doğrulama zorunlu 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ş üst düzeyse öne eğik çizgi (/) olarak gösterilir.
recoveryEmail

string

Kullanıcının kurtarma e-postası.
recoveryPhone

string

Kullanıcının kurtarma telefonu. Telefon numarası, artı işaretiyle (+) başlayan E.164 biçiminde olmalıdır. Örnek: +16506661212.

UserName

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

string

Ad ve soyadı değerlerinin birleştirilmesiyle oluşturulan kullanıcının tam adı.
familyName

string

Kullanıcının soyadı. Kullanıcı hesabı oluştururken gereklidir.
givenName

string

Kullanıcının adı. Kullanıcı hesabı oluştururken gereklidir.
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ı alır.

insert

 Bir kullanıcı oluşturur.

list

 Silinen 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ğini kullanarak 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

 Silinen bir kullanıcının silinmesini geri alır.

update

 Kullanıcıyı günceller.

watch

 Kullanıcı listesinde değişiklikleri izler.