REST Resource: users

Zasób: User

Interfejs Directory API umożliwia tworzenie użytkowników, aliasów użytkowników i zdjęć profilowych Google użytkowników na koncie oraz zarządzanie nimi. Więcej informacji o typowych zadaniach znajdziesz w przewodniku dla programistów dotyczącym kont użytkowników i przewodniku dla programistów dotyczącym aliasów użytkowników.

Zapis 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, "isGuestUser": boolean, "guestAccountInfo": { object (GuestAccountInfo) }, "suspensionTime": string, "archivalTime": string }

Pola
id	string Unikalny identyfikator użytkownika. Użytkownik id może być używany jako userKey w identyfikatorze URI żądania użytkownika.
primaryEmail	string Podstawowy adres e-mail użytkownika. Ta właściwość jest wymagana w prośbie o utworzenie konta użytkownika. primaryEmail musi być niepowtarzalny i nie może być aliasem innego użytkownika.
password	value (Value format) Przechowuje hasło do konta użytkownika. Podczas tworzenia konta użytkownika wymagana jest wartość hasła użytkownika. Jest to opcjonalne podczas aktualizowania użytkownika i należy je podać tylko wtedy, gdy użytkownik aktualizuje hasło do konta. Wartość hasła nigdy nie jest zwracana w treści odpowiedzi interfejsu API.  Hasło może zawierać dowolną kombinację znaków ASCII i musi mieć od 8 do 100 znaków. Zalecamy wysyłanie parametru password jako wartości skrótu zakodowanej w systemie szesnastkowym i odpowiednie ustawienie parametru hashFunction. Jeśli określono wartość hashFunction, hasło musi być prawidłowym kluczem haszowania.
hashFunction	string Przechowuje format skrótu właściwości password. Dozwolone są te wartości hashFunction: MD5 – akceptuje proste wartości zakodowane w systemie szesnastkowym. SHA-1 – akceptuje proste wartości zakodowane w systemie szesnastkowym. crypt – zgodny z biblioteką szyfrowania C. Obsługuje algorytmy szyfrowania DES, MD5 (prefiks haszu $1$), SHA-256 (prefiks haszu $5$) i SHA-512 (prefiks haszu $6$). Jeśli rundy są określone w prefiksie, ich liczba nie może przekraczać 10 000.
isAdmin	boolean Tylko dane wyjściowe. Wskazuje użytkownika z uprawnieniami superadministratora. Właściwość isAdmin można edytować tylko w operacji Ustawianie użytkownika jako administratora ( metoda makeAdmin). Jeśli edytujesz dane w metodach insert lub update, usługa API zignoruje zmiany.
isDelegatedAdmin	boolean Tylko dane wyjściowe. Wskazuje, czy użytkownik jest administratorem delegowanym. Administratorzy delegowani są obsługiwani przez interfejs API, ale nie mogą tworzyć ani przywracać użytkowników ani nadawać im uprawnień administratora. Usługa API ignoruje te żądania. Role i uprawnienia administratorów są przypisywane w konsoli administracyjnej.
agreedToTerms	boolean Tylko dane wyjściowe. Ta właściwość ma wartość true, jeśli użytkownik zalogował się po raz pierwszy i zaakceptował Warunki korzystania z usługi.
suspended	boolean Wskazuje, czy użytkownik jest zawieszony.
changePasswordAtNextLogin	boolean Wskazuje, czy użytkownik musi zmienić hasło przy następnym logowaniu. To ustawienie nie ma zastosowania, gdy użytkownik loguje się za pomocą zewnętrznego dostawcy tożsamości.
ipWhitelisted	boolean Jeśli true, adres IP użytkownika podlega konfiguracji wycofanego adresu IP allowlist.
name	object (UserName) Zawiera imię i nazwisko użytkownika oraz wartość fullName tylko do odczytu. Maksymalna liczba znaków w wartościach givenName i familyName to 60. Wartości nazw obsługują znaki Unicode/UTF-8 i mogą zawierać spacje, litery (a–z), cyfry (0–9), łączniki (-), ukośniki (/) i kropki (.). Więcej informacji o zasadach używania znaków znajdziesz w Centrum pomocy dotyczącej administracji. Maksymalny dozwolony rozmiar danych w tym polu to 1 KB.
kind	string Tylko dane wyjściowe. Typ zasobu interfejsu API. W przypadku zasobów Users wartość to admin#directory#user.
etag	string Tylko dane wyjściowe. ETag zasobu.
emails	value (Value format) Lista adresów e-mail użytkownika. Maksymalny dozwolony rozmiar danych to 10 KB. Pola emails[].address string Adres e-mail użytkownika. Służy również jako identyfikator e-mail. Może to być podstawowy adres e-mail użytkownika lub alias. emails[].customType string Jeśli adres e-mail type to custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona. emails[].primary boolean Wskazuje, czy jest to podstawowy adres e-mail użytkownika. Jako podstawowy można oznaczyć tylko 1 wpis. emails[].type string Typ konta e-mail. Jeśli wartość tego parametru to custom, musisz też ustawić parametr customType. Dozwolone wartości: custom, home, other, work.
externalIds	value (Value format) Lista identyfikatorów zewnętrznych użytkownika, np. identyfikator pracownika lub sieci. Maksymalny dozwolony rozmiar danych to 2 KB. Pola externalIds[].customType string Jeśli zewnętrzny identyfikator type ma wartość custom, ta właściwość zawiera wartość niestandardową i musi być skonfigurowana. externalIds[].type string Typ zewnętrznego identyfikatora. Jeśli wartość to custom, musi być też ustawiona wartość customType. Dozwolone wartości: account, custom, customer, login_id, network, organization. externalIds[].value string Wartość zewnętrznego identyfikatora.
relations	value (Value format) Lista relacji użytkownika z innymi użytkownikami. Maksymalny dozwolony rozmiar danych w tym polu to 2 KB. Więcej informacji znajdziesz w artykule Zarządzanie kontami użytkowników. Pola relations[].customType string Jeśli relacja type ma wartość custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona. relations[].type string Typ relacji. Jeśli wartość to custom, musi być też ustawiona wartość customType. Akceptowane wartości: 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 Adres e-mail osoby, z którą użytkownik jest powiązany.
aliases[]	string Tylko dane wyjściowe. Lista adresów e-mail aliasów użytkownika.
isMailboxSetup	boolean Tylko dane wyjściowe. Wskazuje, czy skrzynka pocztowa Google użytkownika została utworzona. Ta właściwość ma zastosowanie tylko wtedy, gdy użytkownik ma przypisaną licencję Gmail.
customerId	string Tylko dane wyjściowe. Identyfikator klienta, aby pobrać wszystkich użytkowników konta. Możesz użyć aliasu my_customer, aby reprezentować customerId Twojego konta. Jako administrator sprzedawcy możesz użyć customerId konta klienta, któremu sprzedajesz usługi. Aby uzyskać customerId, użyj domeny podstawowej konta w parametrze domain żądania users.list.
addresses	value (Value format) Lista adresów użytkownika. Maksymalny dozwolony rozmiar danych to 10 KB. Pola addresses[].country string Kraj. addresses[].countryCode string Kod kraju. Zgodny ze standardem ISO 3166-1. addresses[].customType string Jeśli adres type to custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona. addresses[].extendedAddress string W przypadku rozszerzonych adresów, np. adresów zawierających podregion. addresses[].formatted string Pełny, nieustrukturyzowany adres pocztowy. Nie jest on synchronizowany ze strukturalnymi polami adresu. Zawiera te atrybuty: adres, skrytka pocztowa, miasto, stan/województwo, kod pocztowy, kraj/region. addresses[].locality string Miejscowość lub miasto w adresie. addresses[].poBox string Numer skrytki pocztowej, jeśli jest dostępny. addresses[].postalCode string Kod pocztowy (w stosownych przypadkach). addresses[].primary boolean Jeśli jest to podstawowy adres użytkownika. Lista adresów może zawierać tylko 1 adres podstawowy. addresses[].region string Skrócona nazwa województwa lub stanu. addresses[].sourceIsStructured boolean Wskazuje, czy podany przez użytkownika adres został sformatowany. Adresy sformatowane nie są obecnie obsługiwane. addresses[].streetAddress string Ulica i numer, np. 1600 Amphitheatre Parkway. Białe znaki w ciągu są ignorowane, ale znaki nowego wiersza mają znaczenie. addresses[].type string Typ adresu. Jeśli wartość tego parametru to custom, musisz też ustawić parametr customType. Dozwolone wartości: custom, home, other, work.
organizations	value (Value format) Lista organizacji, do których należy użytkownik. Maksymalny dozwolony rozmiar danych to 10 KB. Pola organizations[].costCenter string Centrum kosztów organizacji użytkownika. organizations[].customType string Jeśli wartość atrybutu type to custom, ta właściwość zawiera typ niestandardowy. organizations[].department string Określa dział w organizacji, np. sales lub engineering. organizations[].description string Opis organizacji. organizations[].domain string Domena, do której należy organizacja. organizations[].fullTimeEquivalent integer Pełnoetatowy ekwiwalent w miliprocentach w organizacji (100 000 = 100%). organizations[].location string Fizyczna lokalizacja organizacji. Nie musi to być pełny i jednoznaczny adres. organizations[].name string Nazwa organizacji. organizations[].primary boolean Wskazuje, czy jest to podstawowa organizacja użytkownika. Użytkownik może mieć tylko jedną podstawową organizację. organizations[].symbol string Symbol tekstowy organizacji. Na przykład symbol tekstowy Google to GOOG. organizations[].title string Stanowisko użytkownika w organizacji. Na przykład member lub engineer. organizations[].type string Typ organizacji. Dozwolone wartości: domain_only, school, unknown, work.
lastLoginTime	string Tylko dane wyjściowe. kiedy użytkownik ostatnio zalogował się na swoje konto, Wartość jest podana w formacie daty i godziny ISO 8601. Czas to pełna data oraz godziny, minuty i sekundy w formacie YYYY-MM-DDThh:mm:ssTZD. Na przykład: 2010-04-05T17:30:04+01:00.
phones	value (Value format) Lista numerów telefonów użytkownika. Maksymalny dozwolony rozmiar danych to 1 KB. Pola phones[].customType string Jeśli numer telefonu type to custom, ta właściwość zawiera wartość niestandardową i musi być skonfigurowana. phones[].primary boolean Jeśli true, jest to główny numer telefonu użytkownika. Użytkownik może mieć tylko 1 główny numer telefonu. phones[].type string Typ numeru telefonu. Jeśli wartość to custom, należy też ustawić wartość customType. Dozwolone wartości: 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 Numer telefonu w formacie czytelnym dla człowieka. Może być w dowolnym formacie numeru telefonu.
suspensionReason	string Tylko dane wyjściowe. Zawiera powód zawieszenia konta użytkownika przez administratora lub Google w momencie zawieszenia. Właściwość jest zwracana tylko wtedy, gdy właściwość suspended ma wartość true.
thumbnailPhotoUrl	string Tylko dane wyjściowe. Adres URL zdjęcia profilowego użytkownika. Adres URL może być tymczasowy lub prywatny.
languages	value (Value format) Lista języków użytkownika. Maksymalny dozwolony rozmiar danych to 1 KB. Pola languages[].customLanguage string Inny język. Użytkownik może podać własną nazwę języka, jeśli nie ma odpowiedniego kodu języka w formacie ISO 639. Jeśli to ustawienie jest włączone, nie można ustawić languageCode. languages[].languageCode string Ciąg znaków ISO 639 reprezentujący język. Listę obsługiwanych kodów znajdziesz w sekcji Kody języków. Interfejs API zaakceptuje prawidłowe kody języków spoza obsługiwanego zestawu, ale może to prowadzić do nieoczekiwanych zachowań. Nieprawidłowe wartości powodują SchemaException. Jeśli to ustawienie jest włączone, nie można ustawić customLanguage. languages[].preference string Opcjonalnie. Jeśli jest obecny, określa, czy podany język languageCode jest preferowanym językiem użytkownika. Jeśli ustawiono customLanguage, nie można ustawić tej wartości. Dozwolone wartości to preferred i not_preferred.
posixAccounts	value (Value format) Lista informacji o koncie POSIX użytkownika. Pola posixAccounts[].accountId string Identyfikator pola konta POSIX. posixAccounts[].gecos string GECOS (informacje o użytkowniku) na tym koncie. posixAccounts[].gid unsigned long Domyślny identyfikator grupy. posixAccounts[].homeDirectory string Ścieżka do katalogu domowego tego konta. posixAccounts[].operatingSystemType string Typ systemu operacyjnego tego konta. Akceptowane wartości: linux, unspecified, windows. posixAccounts[].primary boolean Czy jest to główne konto użytkownika w ramach SystemId. posixAccounts[].shell string Ścieżka do powłoki logowania na tym koncie. posixAccounts[].systemId string Identyfikator systemu, do którego odnosi się nazwa użytkownika lub identyfikator UID konta. posixAccounts[].uid unsigned long Identyfikator użytkownika zgodny ze standardem POSIX. posixAccounts[].username string Nazwa użytkownika konta.
creationTime	string Tylko dane wyjściowe. Czas utworzenia konta użytkownika. Wartość jest podana w formacie daty i godziny ISO 8601. Czas to pełna data oraz godziny, minuty i sekundy w formacie YYYY-MM-DDThh:mm:ssTZD. Na przykład: 2010-04-05T17:30:04+01:00.
nonEditableAliases[]	string Tylko dane wyjściowe. Lista adresów e-mail aliasów użytkownika, których nie można edytować. Zazwyczaj znajdują się one poza domeną podstawową lub subdomeną konta.
sshPublicKeys	value (Value format) Lista kluczy publicznych SSH. Pola sshPublicKeys[].expirationTimeUsec long Czas wygaśnięcia w mikrosekundach od początku epoki. sshPublicKeys[].fingerprint string Odcisk cyfrowy SHA-256 klucza publicznego SSH. (Tylko do odczytu) sshPublicKeys[].key string Klucz publiczny SSH.
notes	value (Value format) Notatki dla użytkownika jako obiekt zagnieżdżony. Pola notes.contentType string Typ treści notatki: zwykły tekst lub HTML. Domyślnie jest to zwykły tekst. Akceptowane wartości: text_plain, text_html. notes.value string Zawartość notatek.
websites	value (Value format) Lista witryn użytkownika. Pola websites[].customType string Jeśli witryna type ma wartość custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona. websites[].primary boolean Jeśli true, jest to główna witryna użytkownika. websites[].type string Rodzaj lub cel witryny. Na przykład witryna może mieć etykietę home lub blog. Wpis może też mieć typ custom. Jeśli wartość to custom, należy też ustawić wartość customType. Dopuszczalne wartości: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work. websites[].value string Adres URL witryny.
locations	value (Value format) Lista lokalizacji użytkownika. Maksymalny dozwolony rozmiar danych to 10 KB. Pola locations[].area string Wymagane. Lokalizacja tekstowa. Jest to najlepszy sposób na zwięzły opis danego miejsca. Na przykład Mountain View, CA lub Near Seattle. locations[].buildingId string Identyfikator budynku. locations[].customType string Jeśli lokalizacja type to custom, ta właściwość zawiera wartość niestandardową i musi być skonfigurowana. locations[].deskCode string Najdokładniejszy kod tekstowy lokalizacji pojedynczego biurka. locations[].floorName string Nazwa lub numer piętra. locations[].floorSection string Obszar piętra. Dokładniejsza lokalizacja na piętrze. Jeśli np. piętro jest podzielone na obszary A, B i C, to pole będzie zawierać jedną z tych wartości. locations[].type string Typ lokalizacji. Jeśli wartość tego parametru to custom, musisz też ustawić parametr customType. Dozwolone wartości: custom, default, desk.
includeInGlobalAddressList	boolean Wskazuje, czy profil użytkownika jest widoczny na globalnej liście adresów Google Workspace, gdy w domenie jest włączona funkcja udostępniania kontaktów. Więcej informacji o wykluczaniu profili użytkowników znajdziesz w Centrum pomocy dla administratorów.
keywords	value (Value format) Lista słów kluczowych użytkownika. Maksymalny dozwolony rozmiar danych to 1 KB. Pola keywords[].customType string Jeśli słowo kluczowe type ma wartość custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona. keywords[].type string Każdy wpis może mieć typ, który wskazuje standardowy typ tego wpisu.  Na przykład słowo kluczowe może być typu occupation lub outlook. Oprócz standardowego typu wpis może mieć typ custom i dowolną nazwę. Jeśli wartość tego parametru to custom, musisz też ustawić parametr customType. Dozwolone wartości: custom, mission, occupation, outlook. keywords[].value string Słowo kluczowe.
deletionTime	string Tylko dane wyjściowe. Czas usunięcia konta użytkownika. Wartość jest podana w formacie daty i godziny ISO 8601. Czas to pełna data oraz godziny, minuty i sekundy w formacie YYYY-MM-DDThh:mm:ssTZD. Na przykład 2010-04-05T17:30:04+01:00.
gender	value (Value format) Zagnieżdżony obiekt zawierający płeć użytkownika. Maksymalny dozwolony rozmiar danych w tym polu to 1 KB. Pola gender.addressMeAs string Zrozumiały dla człowieka ciąg tekstowy zawierający prawidłowy sposób odniesienia się do właściciela profilu, np. „on/jego/jemu” lub „oni/ich/im”. gender.customGender string Nazwa niestandardowej płci. gender.type string Rodzaj płci. Akceptowane wartości: female male other unknown
thumbnailPhotoEtag	string Tylko dane wyjściowe. ETag zdjęcia użytkownika (tylko do odczytu)
ims	value (Value format) konta komunikatora internetowego użytkownika; Konto użytkownika może mieć wiele usług ims, ale tylko jedna z nich może być głównym kontaktem do komunikatora.ims Pola ims[].customProtocol string Jeśli wartość protokołu to custom_protocol, ta właściwość zawiera ciąg niestandardowego protokołu. ims[].customType string Jeśli IM type ma wartość custom, ta właściwość zawiera wartość niestandardową i musi być skonfigurowana. ims[].im string Identyfikator sieci komunikatora użytkownika. ims[].primary boolean Jeśli jest to podstawowy komunikator użytkownika. Tylko jeden wpis na liście komunikatorów może mieć wartość „true”. ims[].protocol string Protokół komunikatora identyfikuje sieć komunikatora. Może to być sieć niestandardowa lub standardowa. Akceptowane wartości: aim: protokół AOL Instant Messenger custom_protocol: niestandardowy protokół sieci komunikatora, gtalk: protokół Google Talk icq: protokół ICQ jabber: protokół Jabber, msn: protokół MSN Messenger net_meeting: protokół Net Meeting qq: protokół QQ skype: protokół Skype yahoo: protokół Yahoo Messenger ims[].type string Typ konta komunikatora. Jeśli wartość tego parametru to custom, musisz też ustawić parametr customType. Dozwolone wartości: custom, home, other, work.
customSchemas	value (Value format) Pola niestandardowe użytkownika. Kluczem jest schemaName, a jego wartościami są 'fieldName': 'field_value'. customSchemas.(key) to zagnieżdżony obiekt. customSchemas.(key).(key) może mieć dowolną wartość.
isEnrolledIn2Sv	boolean Tylko dane wyjściowe. Włączona weryfikacja dwuetapowa (tylko do odczytu)
isEnforcedIn2Sv	boolean Tylko dane wyjściowe. Czy weryfikacja dwuetapowa jest wymuszana (tylko do odczytu)
archived	boolean Wskazuje, czy użytkownik jest zarchiwizowany.
orgUnitPath	string Pełna ścieżka organizacji nadrzędnej powiązanej z użytkownikiem. Jeśli organizacja nadrzędna jest organizacją najwyższego poziomu, jest reprezentowana przez ukośnik (/).
recoveryEmail	string Pomocniczy adres e-mail użytkownika.
recoveryPhone	string Pomocniczy numer telefonu użytkownika. Numer telefonu musi być w formacie E.164 i zaczynać się od znaku plus (+). Przykład: [phone].
isGuestUser	boolean Pole niemutowalne. Wskazuje, czy wstawiony użytkownik jest gościem.
guestAccountInfo	object (GuestAccountInfo) Niezmienne. Dodatkowe pola metadanych związane z gośćmi
suspensionTime	string Tylko dane wyjściowe. Czas zawieszenia konta użytkownika. (Tylko do odczytu)
archivalTime	string Tylko dane wyjściowe. Czas archiwizacji konta użytkownika. (Tylko do odczytu)

Nazwa użytkownika

Zapis JSON
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

Pola
fullName	string Pełne imię i nazwisko użytkownika utworzone przez połączenie wartości imienia i nazwiska.
familyName	string Nazwisko użytkownika. Wymagane podczas tworzenia konta użytkownika.
givenName	string Imię użytkownika. Wymagane podczas tworzenia konta użytkownika.
displayName	string Wyświetlana nazwa użytkownika. Limit: 256 znaków.

GuestAccountInfo

Informacje o koncie dotyczące użytkowników-gości.

Zapis JSON
{ "primaryGuestEmail": string }

Pola
primaryGuestEmail	string Pole niezmienne. Zewnętrzny adres e-mail gościa.

Metody
createGuest	Utwórz użytkownika-gościa z dostępem do podzbioru funkcji Workspace.
delete	Usuwa użytkownika.
get	Pobiera użytkownika.
insert	Tworzy użytkownika.
list	Pobiera stronicowaną listę usuniętych lub wszystkich użytkowników w domenie.
makeAdmin	Przypisuje użytkownikowi rolę superadministratora.
patch	Aktualizuje użytkownika za pomocą semantyki poprawki.
signOut	Wylogowuje użytkownika ze wszystkich sesji w internecie i na urządzeniach oraz resetuje jego pliki cookie logowania.
undelete	Przywraca usunięte konto użytkownika.
update	Aktualizuje użytkownika.
watch	Śledzi zmiany na liście użytkowników.