REST Resource: users

Zasób: User

Interfejs Directory API umożliwia tworzenie kont użytkowników, aliasów użytkowników i zdjęć profilowych użytkowników konta oraz zarządzanie nimi. Więcej informacji o typowych zadaniach znajdziesz w Przewodniku dla programistów 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 }

Pola
id	string Unikalny identyfikator użytkownika. Użytkownika id można używać jako identyfikatora userKey URI żądania użytkownika.
primaryEmail	string Podstawowy adres e-mail użytkownika. Ta usługa jest wymagana w żądaniu utworzenia konta użytkownika. Domena primaryEmail musi być unikalna i nie może być aliasem innego użytkownika.
password	value (Value format) Zapisuje hasło do konta użytkownika. Podczas tworzenia konta użytkownika wymagana jest wartość hasła. Jest ono opcjonalne przy aktualizowaniu użytkownika i należy je podawać tylko wtedy, gdy użytkownik zmienia swoje 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ć długość 8–100 znaków. Zalecamy wysyłanie parametru password w postaci zakodowanej szesnastkowej wartości skrótu i odpowiednie ustawienie parametru hashFunction. Jeśli określono hashFunction, hasło musi być prawidłowym kluczem skrótu.
hashFunction	string Przechowuje format skrótu właściwości password. Następujące wartości hashFunction są dozwolone: MD5 – akceptowalne są proste wartości zakodowane pod postacią liczb szesnastkowych. SHA-1 – akceptowalne są proste wartości zakodowane pod postacią liczb szesnastkowych. crypt – zgodność z biblioteką kryptów C. Obsługuje algorytmy szyfrowania DES, MD5 (prefiks skrótu $1$), SHA-256 (prefiks skrótu $5$) i SHA-512 (prefiks skrótu $6$). Jeśli częścią prefiksu są rundy, ich liczba nie może być większa niż 10 000.
isAdmin	boolean Tylko dane wyjściowe. Wskazuje użytkownika z uprawnieniami superadministratora. Właściwość isAdmin można edytować tylko w ramach operacji Nadaj użytkownikowi uprawnienia administratora ( metoda makeAdmin). Jeśli wprowadzisz zmiany w metodzie insert lub update przez użytkownika, zostanie ona zignorowana przez usługę interfejsu API.
isDelegatedAdmin	boolean Tylko dane wyjściowe. Wskazuje, czy użytkownik jest wyznaczonym administratorem. Administratorzy delegowani są obsługiwani przez interfejs API, ale nie mogą tworzyć ani przywracać użytkowników ani przyznawać im uprawnień administratora. Te żądania są ignorowane przez usługę interfejsu API. Role i uprawnienia administratorów są przypisywane w konsoli administracyjnej.
agreedToTerms	boolean Tylko dane wyjściowe. Jeśli użytkownik przeprowadził wstępne logowanie i zaakceptował Warunki korzystania z usługi, ta usługa ma stan true.
suspended	boolean Wskazuje, czy użytkownik jest zawieszony.
changePasswordAtNextLogin	boolean Wskazuje, czy użytkownik musi zmienić hasło podczas następnego logowania. To ustawienie nie ma zastosowania, gdy użytkownik loguje się przez zewnętrznego dostawcę tożsamości.
ipWhitelisted	boolean W przypadku ustawienia true adres IP użytkownika jest objęty wycofaną konfiguracją adresu IP allowlist.
name	object (UserName) Zawiera imię i nazwisko użytkownika oraz wartość fullName tylko do odczytu. Maksymalna liczba znaków w polach givenName i familyName to 60. Dodatkowo 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 regułach użycia znaków znajdziesz w Centrum pomocy dla administratorów. Maksymalny dozwolony rozmiar danych w tym polu to 1 KB.
kind	string Tylko dane wyjściowe. Typ zasobu interfejsu API. W przypadku zasobów użytkowników wartość wynosi admin#directory#user.
etag	string Tylko dane wyjściowe. Tag 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 też 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 zostać skonfigurowana. emails[].primary boolean Wskazuje, czy jest to główny adres e-mail użytkownika. Tylko 1 wpis można oznaczyć jako główny. emails[].type string Typ konta e-mail. Jeśli zasada ma wartość custom, musi być też ustawiona wartość customType. Akceptowane wartości: custom, home, other, work.
externalIds	value (Value format) Lista zewnętrznych identyfikatorów użytkownika, takich jak identyfikator pracownika lub sieci. Maksymalny dozwolony rozmiar danych to 2 KB. Pola externalIds[].customType string Jeśli identyfikator zewnętrzny type to custom, ta właściwość zawiera wartość niestandardową i musi zostać ustawiona. externalIds[].type string Typ identyfikatora zewnętrznego. Jeśli zasada ma wartość custom, musi być też ustawiona wartość customType. Akceptowane wartości: account, custom, customer, login_id, network, organization. externalIds[].value string Wartość identyfikatora zewnętrznego.
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 to custom, ta właściwość zawiera wartość niestandardową i musi zostać ustawiona. relations[].type string Typ relacji. Jeśli zasada ma wartość 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ą jest powiązany użytkownik.
aliases[]	string Tylko dane wyjściowe. Lista aliasów e-mail użytkownika.
isMailboxSetup	boolean Tylko dane wyjściowe. Wskazuje, czy skrzynka pocztowa Google użytkownika została utworzona. Ta usługa ma zastosowanie tylko wtedy, gdy użytkownikowi przypisano licencję na Gmaila.
customerId	string Tylko dane wyjściowe. Identyfikator klienta umożliwiający pobranie wszystkich użytkowników konta. Możesz użyć aliasu my_customer do reprezentowania domeny customerId na Twoim koncie. Jako administrator sprzedawcy możesz używać customerId konta klienta sprzedawcy. 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. Jest 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 adresów rozszerzonych, takich jak adresy obejmujące podregion. addresses[].formatted string Pełny i nieuporządkowany adres pocztowy. Te dane nie są synchronizowane z uporządkowanymi polami adresu. Zawiera następujące atrybuty: adres, adres pocztowy, P.O. pole, miasto, województwo, kod pocztowy, kraj/region. addresses[].locality string Miejscowość, w której znajduje się adres. addresses[].poBox string Skrytka pocztowa (jeśli jest dostępna). addresses[].postalCode string Kod pocztowy (jeśli dotyczy). addresses[].primary boolean Jeśli jest to podstawowy adres użytkownika. Lista adresów może zawierać tylko jeden adres podstawowy. addresses[].region string Skrócona nazwa prowincji lub województwa. addresses[].sourceIsStructured boolean Wskazuje, czy adres podany przez użytkownika został sformatowany. Sformatowane adresy nie są obecnie obsługiwane. addresses[].streetAddress string Ulica i numer, na przykład 1600 Amphitheatre Parkway. Odstępy w ciągu znaków są ignorowane. jednak znaki nowego wiersza mają znaczenie. addresses[].type string Typ adresu. Jeśli zasada ma wartość custom, musi być też ustawiona wartość customType. Akceptowane 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ść typu jest niestandardowa, ta właściwość zawiera typ niestandardowy. organizations[].department string Określa dział organizacji, na przykład sales lub engineering. organizations[].description string Opis organizacji. organizations[].domain string Domena, do której należy organizacja. organizations[].fullTimeEquivalent integer Równowartość w miliprocentach czasu pracy 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 główna organizacja użytkownika. Użytkownik może mieć tylko 1 organizację podstawową. organizations[].symbol string Symbol ciągu tekstowego reprezentującego organizację. Na przykład symbol tekstu dla Google to GOOG. organizations[].title string Stanowisko użytkownika w organizacji. na przykład member lub engineer. organizations[].type string Typ organizacji. Akceptowane wartości: domain_only, school, unknown oraz work.
lastLoginTime	string Tylko dane wyjściowe. Czas ostatniego logowania na konto użytkownika. Wartość jest w formacie daty i godziny w standardzie ISO 8601. Czas to pełna data oraz godziny, minuty i sekundy w formularzu 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ć ustawiona. phones[].primary boolean Jeśli true, jest to podstawowy numer telefonu użytkownika. Użytkownik może mieć tylko jeden podstawowy numer telefonu. phones[].type string Typ numeru telefonu. Jeśli ustawiona jest wartość custom, musi też być ustawiona wartość customType. Akceptowane 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_mobilework_pager phones[].value string Numer telefonu zrozumiały dla człowieka. Może to być dowolny format numeru telefonu.
suspensionReason	string Tylko dane wyjściowe. powód zawieszenia konta użytkownika przez administratora lub Google w chwili 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. 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. Jeśli nie ma kodu języka ISO 639, użytkownik może podać własną nazwę języka. Jeśli ta opcja jest ustawiona, nie można ustawić opcji languageCode. languages[].languageCode string Reprezentacja języka w ciągu znaków ISO 639. Listę obsługiwanych kodów znajdziesz w sekcji Kody języków. Prawidłowe kody języków spoza obsługiwanego zestawu będą akceptowane przez interfejs API, ale mogą powodować nieoczekiwane działanie. Nieprawidłowe wartości powodują SchemaException. Jeśli ta opcja jest ustawiona, nie można ustawić opcji customLanguage. languages[].preference string Opcjonalnie: Jeśli jest dostępny, określa, czy languageCode jest preferowanym językiem użytkownika. Nie można tego zrobić, jeśli ustawiono wartość customLanguage. 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) dla tego konta. posixAccounts[].gid unsigned long Domyślny identyfikator grupy. posixAccounts[].homeDirectory string Ścieżka do katalogu głównego tego konta. posixAccounts[].operatingSystemType string Typ systemu operacyjnego dla tego konta. Akceptowane wartości: linux, unspecified oraz windows. posixAccounts[].primary boolean Jeśli jest to główne konto użytkownika w ramach identyfikatora SystemId. posixAccounts[].shell string Ścieżka do powłoki logowania tego konta. posixAccounts[].systemId string Identyfikator systemowy konta, do którego odnosi się nazwa użytkownika lub identyfikator UID. posixAccounts[].uid unsigned long Identyfikator użytkownika zgodny z POSIX. posixAccounts[].username string Nazwa użytkownika konta.
creationTime	string Tylko dane wyjściowe. Czas utworzenia konta użytkownika. Wartość jest w formacie daty i godziny w standardzie ISO 8601. Czas to pełna data oraz godziny, minuty i sekundy w formularzu YYYY-MM-DDThh:mm:ssTZD. Na przykład: 2010-04-05T17:30:04+01:00.
nonEditableAliases[]	string Tylko dane wyjściowe. Lista aliasów e-mail użytkownika, których nie można edytować. Są to zazwyczaj spoza domeny podstawowej lub subdomeny 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 zagnieżdżony obiekt. 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 i text_html. notes.value string Zawartość notatek.
websites	value (Value format) Lista witryn użytkownika. Pola websites[].customType string Jeśli witryna type to 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 Typ lub przeznaczenie witryny. Witryna może mieć na przykład etykietę home lub blog. Wpis może też mieć typ custom. Jeśli ustawiona jest wartość custom, musi być też ustawiona wartość customType. Akceptowane 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 Lokalizacja tekstowa. Ta metoda najlepiej sprawdza się przy wyświetlaniu, gdy chcesz zwięźle opisać lokalizację. 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ć ustawiona. locations[].deskCode string Najdokładniejszy kod tekstowy lokalizacji pojedynczego biurka. locations[].floorName string Nazwa lub numer piętra. locations[].floorSection string Sekcja piętra. Bardziej szczegółowa lokalizacja na piętrze. Jeśli np. piętro jest podzielone na sekcje A, B i C, to pole wskaże jedną z nich. locations[].type string Typ lokalizacji. Jeśli zasada ma wartość custom, musi być też ustawiona wartość customType. Akceptowane 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 na temat wykluczania 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 to custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona. keywords[].type string Każdy wpis może mieć typ wskazujący typ standardowy. Przykładowo słowo kluczowe może być typu occupation lub outlook. Oprócz typu standardowego wpis może mieć typ custom i nadać mu dowolną nazwę. Jeśli zasada ma wartość custom, musi być też ustawiona wartość customType. Akceptowane 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 w formacie daty i godziny w standardzie ISO 8601. Czas to pełna data oraz godziny, minuty i sekundy w formularzu 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 odpowiednie informacje o właścicielu profilu, na przykład „on/jego”. lub „oni/ich/swoje”. gender.customGender string Nazwa płci niestandardowej. gender.type string Rodzaj płci. Akceptowane wartości: female male other unknown
thumbnailPhotoEtag	string Tylko dane wyjściowe. Tag ETag zdjęcia użytkownika (tylko do odczytu)
ims	value (Value format) konta czatu użytkownika. Konto użytkownika może mieć wiele usług ims, ale tylko jedna z tych usług ims może być główną osobą kontaktową w komunikatorze. Pola ims[].customProtocol string Jeśli wartością protokołu jest custom_protocol, ta właściwość zawiera ciąg znaków protokołu niestandardowego. ims[].customType string Jeśli type komunikatora to custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona. ims[].im string Identyfikator sieci komunikatora użytkownika. ims[].primary boolean Jeśli jest to główny komunikator użytkownika. Tylko jeden wpis na liście czatów może mieć wartość true (prawda). ims[].protocol string Protokół komunikatora określa sieć komunikatora. Może to być sieć niestandardowa lub sieć standardowa. Akceptowane wartości: aim: protokół komunikatora AOL Instant Messenger custom_protocol: niestandardowy protokół sieciowy 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 zasada ma wartość custom, musi być też ustawiona wartość customType. Akceptowane wartości: custom, home, other, work.
customSchemas	value (Value format) Pola niestandardowe użytkownika. Klucz to schemaName, a jego wartości to 'fieldName': 'field_value'. customSchemas.(key) to obiekt zagnieżdżony. customSchemas.(key).(key) może mieć dowolną wartość.
isEnrolledIn2Sv	boolean Tylko dane wyjściowe. Korzysta z weryfikacji dwuetapowej (tylko do odczytu).
isEnforcedIn2Sv	boolean Tylko dane wyjściowe. Wymuszanie weryfikacji dwuetapowej (tylko do odczytu)
archived	boolean Wskazuje, czy konto użytkownika zostało zarchiwizowane.
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 ona reprezentowana jako ukośnik (/).
recoveryEmail	string Pomocniczy adres e-mail użytkownika.
recoveryPhone	string Pomocniczy numer telefonu użytkownika. Numer telefonu musi mieć format E.164 i musi zaczynać się od znaku plusa (+). Przykład: [phone].

UserName

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

Pola
fullName	string 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.

Metody
delete	Usuwa konto użytkownika.
get	Pobiera użytkownika.
insert	Tworzy użytkownika.
list	Pobiera podzieloną na strony listę usuniętych użytkowników lub wszystkich użytkowników w domenie.
makeAdmin	Zmienia użytkownika w superadministratora.
patch	Aktualizuje użytkownika za pomocą semantyki poprawki.
signOut	Wylogowuje użytkownika ze wszystkich sesji internetowych i na urządzeniu i resetuje pliki cookie logowania.
undelete	Przywraca usunięte konto użytkownika.
update	Aktualizuje użytkownika.
watch	Monitorowanie zmian na liście użytkowników.