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 Google oraz zarządzanie nimi. Więcej informacji o typowych zadaniach znajdziesz w przewodniku dla programistów kont użytkowników i w 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. id użytkownika może służyć jako identyfikator URI żądania użytkownika userKey.
primaryEmail	string Podstawowy adres e-mail użytkownika. Ta usługa jest wymagana w prośbie o utworzenie konta użytkownika. Element 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. Jest opcjonalna podczas aktualizowania użytkownika i powinna być wymagana tylko wtedy, gdy zmienia 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 w postaci zaszyfrowanej szesnastkowo wartości skrótu i odpowiednie ustawienie parametru hashFunction. Jeśli jest określony hashFunction, hasło musi być prawidłowym kluczem haszującym.
hashFunction	string Zapisuje format skrótu właściwości password. Dozwolone są te wartości hashFunction: MD5 – akceptuje proste wartości zakodowane szesnastkowo. SHA-1 – akceptuje proste wartości zakodowane szesnastkowo. crypt – zgodność z biblioteką kryptograficzną C. Obsługuje algorytmy haszujące DES, MD5 (prefiks skrótu $1$), SHA-256 (prefiks skrótu do $5$) i SHA-512 (prefiks skrótu $6$). Jeśli prefiks jest określony, liczba rund 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 ramach operacji Przyznaj użytkownikowi uprawnienia administratora ( metoda makeAdmin). Jeśli wprowadzisz zmiany w metodzie wstaw lub aktualizacji użytkownika, zmiana zostanie zignorowana przez usługę API.
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 przyznawać użytkownikom uprawnień administratorów. Żądania te są ignorowane przez usługę interfejsu API. Role i uprawnienia administratorów są przypisywane w konsoli administracyjnej.
agreedToTerms	boolean Tylko dane wyjściowe. Ta właściwość to true, jeśli użytkownik przeprowadził wstępne logowanie i zaakceptował Warunki korzystania z usługi.
suspended	boolean Wskazuje, czy konto użytkownika jest zawieszone.
changePasswordAtNextLogin	boolean Wskazuje, czy użytkownik musi zmienić hasło podczas następnego logowania. To ustawienie nie obowiązuje, gdy użytkownik loguje się za pomocą zewnętrznego dostawcy tożsamości.
ipWhitelisted	boolean Jeśli ustawiona jest wartość true, adres IP użytkownika podlega wycofanej konfiguracji adresu IP allowlist.
name	object (UserName) Zawiera imiona i nazwiska użytkownika oraz wartość fullName tylko do odczytu. Maksymalna liczba znaków w wartościach 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. 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. Pełni też funkcję identyfikatora e-maila. Ta wartość może być podstawowym adresem e-mail użytkownika lub aliasem. emails[].customType string Jeśli adres e-mail type to custom, ta właściwość zawiera wartość niestandardową, którą należy ustawić. emails[].primary boolean Wskazuje, czy jest to podstawowy adres e-mail użytkownika. Tylko jeden wpis można oznaczyć jako główny. emails[].type string Typ konta e-mail. Jeśli zasada ma wartość custom, należy też ustawić parametr customType. Akceptowane wartości: custom, home, other oraz work.
externalIds	value (Value format) Lista zewnętrznych identyfikatorów użytkownika, takich jak identyfikator pracownika lub identyfikator 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ą, którą należy ustawić. externalIds[].type string Typ identyfikatora zewnętrznego. Jeśli zasada ma wartość custom, należy też ustawić parametr customType. Akceptowane wartości: account, custom, customer, login_id, network oraz 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ą, którą należy ustawić. relations[].type string Typ relacji. Jeśli jest ustawiona na custom, należy też ustawić parametr 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ą powiązany jest użytkownik.
aliases[]	string Tylko dane wyjściowe. Lista aliasów e-mail użytkownika.
isMailboxSetup	boolean Tylko dane wyjściowe. Wskazuje, czy została utworzona skrzynka pocztowa Google użytkownika. Ta usługa ma zastosowanie tylko wtedy, gdy użytkownikowi przypisano licencję na Gmaila.
customerId	string Tylko dane wyjściowe. Identyfikator klienta do pobierania wszystkich użytkowników konta. Możesz użyć aliasu my_customer do reprezentowania nazwy customerId Twojego konta. 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. Użyj standardu ISO 3166-1. addresses[].customType string Jeśli adres type to custom, ta właściwość zawiera wartość niestandardową, którą należy ustawić. addresses[].extendedAddress string W przypadku rozszerzonych adresów, takich jak adresy obejmujące podregion. addresses[].formatted string Pełny i nieustrukturyzowany adres pocztowy. Ta wartość nie jest synchronizowana z polami adresu strukturalnego. Zawiera te atrybuty: ulica i numer, skrytka pocztowa, miasto, województwo, kod pocztowy, kraj/region. addresses[].locality string Miasto lub miejscowość podane w adresie. addresses[].poBox string Skrytka pocztowa (jeśli jest dostępna). 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 jeden adres główny. addresses[].region string Skrócona prowincja lub stan. addresses[].sourceIsStructured boolean Wskazuje, czy adres podany przez użytkownika został sformatowany. Sformatowane adresy nie są obecnie obsługiwane. addresses[].streetAddress string Adres, np. 1600 Amphitheatre Parkway. Odstępy w ciągu są ignorowane, natomiast znaki nowego wiersza mają znaczenie. addresses[].type string Typ adresu. Jeśli zasada ma wartość custom, należy też ustawić parametr customType. Akceptowane wartości: custom, home, other oraz 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ścią typu jest niestandardowa, ta właściwość zawiera typ niestandardowy. organizations[].department string Określa dział w 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 Odsetek równoważny w pełnym wymiarze godzin 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 jedną organizację główną. organizations[].symbol string Symbol ciągu tekstowego organizacji. Na przykład symbol tekstowy w przypadku Google to GOOG. organizations[].title string Tytuł 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 użytkownika na konto użytkownika. Data i godzina są podane w formacie 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ą, którą należy ustawić. phones[].primary boolean Jeśli true, jest to podstawowy numer telefonu użytkownika. Użytkownik może mieć tylko 1 główny numer telefonu. phones[].type string Typ numeru telefonu. Jeśli jest ustawiona na custom, należy również ustawić 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_faxwork_mobilework_pager phones[].value string Zrozumiały dla człowieka numer telefonu. Może on mieć dowolny format.
suspensionReason	string Tylko dane wyjściowe. podaje powód zawieszenia konta 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 odpowiadającego jej kodu języka ISO 639. Jeśli ta wartość jest skonfigurowana, nie można ustawić wartości languageCode. languages[].languageCode string Język zgodny z formatem 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ą prowadzić do nieoczekiwanego działania. Niedozwolone wartości to SchemaException. Jeśli ta wartość jest skonfigurowana, nie można ustawić wartości customLanguage. languages[].preference string Opcjonalnie. Jeśli ta opcja jest dostępna, określa, czy languageCode jest preferowanym językiem użytkownika. Nie można ustawić wartości 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 na tym koncie. posixAccounts[].operatingSystemType string Typ systemu operacyjnego danego konta. Akceptowane wartości: linux, unspecified oraz windows. posixAccounts[].primary boolean Jeśli jest to podstawowe konto użytkownika w identyfikatorze systemu. posixAccounts[].shell string Ścieżka do powłoki logowania na to konto. posixAccounts[].systemId string Identyfikator systemu, do którego odnosi się nazwa użytkownika lub identyfikator użytkownika konta. posixAccounts[].uid unsigned long Identyfikator użytkownika zgodny z POSIX. posixAccounts[].username string Nazwa użytkownika konta.
creationTime	string Tylko dane wyjściowe. Godzina utworzenia konta użytkownika. Data i godzina są podane w formacie 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 aliasów e-mail użytkownika, których nie można edytować. Zazwyczaj są one 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 w formie obiektu zagnieżdżonego. Pola notes.contentType string Typ treści notatki: zwykły tekst lub HTML. Domyślna opcja to zwykły tekst. Akceptowane wartości: text_plain oraz text_html. notes.value string Treść notatek.
websites	value (Value format) Lista stron internetowych użytkownika. Pola websites[].customType string Jeśli witryna type to custom, ta właściwość zawiera wartość niestandardową, którą należy ustawić. websites[].primary boolean Jeśli ustawiona jest wartość true, jest to główna witryna użytkownika. websites[].type string Typ lub przeznaczenie witryny. Witryna może być na przykład oznaczona etykietą home lub blog. Wpis może też mieć typ custom. Jeśli ma wartość custom, należy też ustawić parametr 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 tekstu. Jest to najbardziej przydatne na potrzeby wyświetlania zwięzłego opisu lokalizacji. 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ą, którą należy ustawić. locations[].deskCode string Najdokładniejszy kod tekstowy miejsca pracy biurka. locations[].floorName string Nazwa lub numer piętra. locations[].floorSection string Obszar piętra. Bardziej szczegółowa lokalizacja na piętrze. Jeśli np. piętro jest podzielone na sekcje A, B i C, to pole identyfikuje jedną z tych wartości. locations[].type string Typ lokalizacji. Jeśli zasada ma wartość custom, należy też ustawić parametr customType. Akceptowane wartości: custom, default oraz desk.
includeInGlobalAddressList	boolean Określa, 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ą, którą należy ustawić. keywords[].type string Każdy wpis może mieć typ, który wskazuje jego standardowy typ. Na przykład słowo kluczowe może być typu occupation lub outlook. Oprócz typu standardowego wpis może też mieć typ custom i dowolną nazwę. Jeśli zasada ma wartość custom, należy też ustawić parametr customType. Akceptowane wartości: custom, mission, occupation oraz outlook. keywords[].value string Słowo kluczowe.
deletionTime	string Tylko dane wyjściowe. Godzina usunięcia konta użytkownika. Data i godzina są podane w formacie 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 właściwe odwoływanie się do właściciela profilu przez innych użytkowników, na przykład „on/jego/jego” lub „on/on/jego”. 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. ETag zdjęcia użytkownika (tylko do odczytu)
ims	value (Value format) Konta błyskawicznego czatu użytkownika. Konto użytkownika może mieć kilka usług w ims, ale tylko jedna z tych usług ims może być główną osobą kontaktową w komunikatorze internetowym. Pola ims[].customProtocol string Jeśli wartością protokołu jest custom_protocol, ta właściwość zawiera ciąg znaków niestandardowego protokołu. ims[].customType string Jeśli type w komunikatorze internetowym to custom, ta właściwość zawiera wartość niestandardową, którą należy ustawić. ims[].im string Identyfikator sieci czatu użytkownika. ims[].primary boolean Jeśli jest to główny komunikator użytkownika. Tylko jedna pozycja na liście komunikatorów może mieć wartość prawda. ims[].protocol string Protokół komunikatora internetowego identyfikuje sieć komunikatora internetowego. Wartością może być sieć niestandardowa lub sieć standardowa. Akceptowane wartości: aim: protokół AOL Instant Messenger custom_protocol: niestandardowy protokół sieciowy komunikatora internetowego 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, należy też ustawić parametr customType. Akceptowane wartości: custom, home, other oraz work.
customSchemas	value (Value format) Pola niestandardowe użytkownika. Klucz to schemaName, a jego wartości to 'fieldName': 'field_value'. customSchemas.(key) jest obiektem zagnieżdżonym. customSchemas.(key).(key) może mieć dowolną wartość.
isEnrolledIn2Sv	boolean Tylko dane wyjściowe. jest zarejestrowany w systemie weryfikacji dwuetapowej (tylko do odczytu),
isEnforcedIn2Sv	boolean Tylko dane wyjściowe. Jest wymuszana weryfikacja dwuetapowa (tylko do odczytu)
archived	boolean Wskazuje, czy konto użytkownika jest 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 przedstawiana za pomocą ukośnika prawego (/).
recoveryEmail	string Adres e-mail odzyskiwania użytkownika.
recoveryPhone	string Pomocniczy numer telefonu użytkownika. Numer telefonu musi mieć format E.164 i zaczynać się znakiem plusa (+), np. [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 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	nadaje użytkownikowi uprawnienia superadministratora.
patch	Aktualizuje użytkownika za pomocą semantyki poprawki.
signOut	Wylogowuje użytkownika ze wszystkich sesji internetowych i na urządzeniu oraz resetuje pliki cookie logowania.
undelete	Przywraca usunięcie usuniętego konta użytkownika.
update	Aktualizuje użytkownika.
watch	Wykrywa zmiany na liście użytkowników.