REST Resource: users

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Zasób: Użytkownik

Interfejs Directory API umożliwia tworzenie kont użytkowników, aliasów użytkowników i zdjęć profilowych użytkowników w Gmailu 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 aliasów aliasó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żyć jako identyfikatora URI żądania userKey.

primaryEmail

string

Podstawowy adres e-mail użytkownika. Ta właściwość 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)

Zapisuje hasło do konta użytkownika. Wartość hasła użytkownika jest wymagana podczas tworzenia konta użytkownika. Jest ona opcjonalna i dostępna 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 oraz musi mieć od 8 do 100 znaków.

Zalecamy użycie parametru password w postaci szesnastkowej i odpowiednie ustawienie parametru hashFunction. Jeśli określona jest wartość hashFunction, hasło musi być prawidłowym kluczem skrótu.

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 – zgodna z biblioteką kryptograficzną C. Obsługuje algorytmy szyfrowania DES, MD5 (z prefiksem $1$), SHA-256 (hash $5$) i SHA-512 (hasła z prefiksem $6$).

Jeśli prefiksy te są określone w ramach prefiksu, 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 Przypisywanie użytkownikowi ról administratora ( metoda makeAdmin). Jeśli zmodyfikujesz ją za pomocą metody insert lub aktualizacji użytkownika, zostanie ona zignorowana przez interfejs 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 usuwać użytkowników ani określać ich jako administratorów. Te żądania są ignorowane przez usługę API.
Role i uprawnienia administratora są przypisywane w konsoli administracyjnej.

agreedToTerms

boolean

Tylko dane wyjściowe. Ta właściwość to true, jeśli użytkownik zalogował się po raz pierwszy i zaakceptował Warunki korzystania z usługi.

suspended

boolean

Wskazuje, czy konto użytkownika jest zawieszone.

changePasswordAtNextLogin

boolean

Wskazuje, czy użytkownik jest zmuszony do zmiany hasła po następnym zalogowaniu. To ustawienie nie ma zastosowania, gdy użytkownik loguje się przy użyciu zewnętrznego dostawcy tożsamości.

ipWhitelisted

boolean

W przypadku true w adresie IP użytkownika jest używana wycofana konfiguracja adresów IP allowlist.

name

object (UserName)

Zawiera imiona i nazwiska rodziny użytkownika oraz wartość fullName tylko do odczytu. Maksymalna liczba znaków w wartościach givenName i familyName jest 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ść 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. 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ą trzeba ustawić.

emails[].primary

boolean

Wskazuje, czy jest to główny adres e-mail użytkownika. Tylko jeden wpis może być oznaczony jako główny.

emails[].type

string

Typ konta e-mail. Jeśli jest ustawiona wartość custom, customType musi też być ustawiona.

Akceptowane wartości: custom, home, other, work.

externalIds

value (Value format)

Lista zewnętrznych identyfikatorów użytkownika, np. identyfikator pracownika lub sieci. Maksymalny dozwolony rozmiar danych to 2 KB.

Pola

externalIds[].customType

string

Jeśli zewnętrzny identyfikator type to custom, ta właściwość zawiera wartość niestandardową i należy ją ustawić.

externalIds[].type

string

Typ identyfikatora zewnętrznego. Jeśli jest ustawiona wartość custom, customType musi też być ustawiona.

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 ma wartość custom, ta właściwość zawiera wartość niestandardową i należy ją ustawić.

relations[].type

string

Typ relacji. Jeśli jest ustawiona wartość custom, należy też ustawić 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 związany.

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 właściwość ma zastosowanie tylko wtedy, gdy użytkownikowi przypisano licencję na Gmaila.

customerId

string

Tylko dane wyjściowe. Identyfikator klienta, aby pobrać wszystkich użytkowników konta.
Jako alias customerId możesz użyć aliasu my_customer.
Jako sprzedawca możesz korzystać z adresu customerId konta klienta sprzedaży. Aby pobrać 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żywany jest standard ISO 3166-1.

addresses[].customType

string

Jeśli adres type to custom, ta właściwość zawiera wartość niestandardową i należy ją ustawić.

addresses[].extendedAddress

string

W przypadku adresów rozszerzonych, np. adresu zawierającego podregion.

addresses[].formatted

string

Pełny i nieuporządkowany adres pocztowy. Te dane nie są zsynchronizowane z polami adresu strukturalnego. Zawiera następujące atrybuty: adres, skrytka pocztowa, miasto, stan/prowincja, kod pocztowy, kraj/region.

addresses[].locality

string

Miasto (lub miejscowość).

addresses[].poBox

string

Skrzynka pocztowa, jeśli występuje.

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 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 znaków są ignorowane, ale znaki nowego wiersza są istotne.

addresses[].type

string

Typ adresu. Jeśli jest ustawiona wartość custom, customType musi też być ustawiona.

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 typ 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

Odpowiednik pełnoetatowy w organizacji (100 000 = 100%).

organizations[].location

string

Fizyczna lokalizacja organizacji. Nie musi to być pełny adres.

organizations[].name

string

Nazwa organizacji.

organizations[].primary

boolean

Wskazuje, czy jest to organizacja podstawowa 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 dla 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, work.

lastLoginTime

string

Tylko dane wyjściowe. Ostatnie zalogowanie użytkownika na konto tego użytkownika. Wartość jest podana w formacie ISO 8601, Godzina to pełna data wraz z liczbą godzin, minut i sekund w postaci 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ą musisz ustawić.

phones[].primary

boolean

Jeśli true, jest to podstawowy numer telefonu użytkownika. Użytkownik może mieć tylko jeden główny numer telefonu.

phones[].type

string

Typ numeru telefonu. Jeśli jest skonfigurowana zasada custom, musisz też ustawić 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.

phones[].value

string

Czytelny numer telefonu. Może mieć dowolny format numeru telefonu.

suspensionReason

string

Tylko dane wyjściowe. Dlaczego konto użytkownika zostało zawieszone 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 użytkownika (tylko do odczytu)

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 ISO 639. Jeśli zasada jest skonfigurowana, nie można ustawić właściwości languageCode.

languages[].languageCode

string

Ciąg znaków w języku 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 to SchemaException. Jeśli zasada jest skonfigurowana, nie można ustawić właściwości customLanguage.

languages[].preference

string

Opcjonalne. Jeśli ta opcja jest dostępna, określa, czy określony język languageCode jest preferowany przez użytkownika. Jeśli zasada ma wartość customLanguage, nie można jej ustawić. 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

Dokument 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, windows.

posixAccounts[].primary

boolean

Jeśli jest to główne konto użytkownika w systemie.

posixAccounts[].shell

string

Ścieżka do powłoki logowania dla tego konta.

posixAccounts[].systemId

string

Identyfikator systemowy konta, którego dotyczy 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. Data utworzenia konta użytkownika. Wartość jest podana w formacie ISO 8601, Godzina to pełna data wraz z liczbą godzin, minut i sekund w postaci 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, których nie można edytować. Zwykle są 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)

Uwagi użytkownika jako obiekt zagnieżdżony.

Pola

notes.contentType

string

Typ treści: zwykły tekst lub kod HTML. Domyślnie jest 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 należy ją ustawić.

websites[].primary

boolean

Jeśli jest to true, jest to główna witryna użytkownika.

websites[].type

string

Typ lub cel witryny. Witryny mogą być na przykład oznaczone jako home lub blog. Każdy wpis może mieć typ custom. Jeśli jest ustawiona wartość custom, customType musi też zostać ustawiona.

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 funkcja najlepiej sprawdza się w przypadku wyświetlaczy i zwięzłego opisywania 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

Najbardziej konkretny kod tekstowy lokalizacji biurka.

locations[].floorName

string

Nazwa/numer piętra.

locations[].floorSection

string

Obszar. Lepsza lokalizacja w podłodze. Jeśli na przykład piętro jest podzielone na sekcje A, B i C, w tym polu pojawi się jedna z tych wartości.

locations[].type

string

Typ lokalizacji. Jeśli jest ustawiona wartość custom, customType musi też być ustawiona.

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 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 jest custom, ta właściwość zawiera wartość niestandardową i należy ją ustawić.

keywords[].type

string

Każdy wpis może mieć typ, który wskazuje jego typ.

Na przykład słowo kluczowe może być typu occupation lub outlook. Oprócz typu standardowego wpis może mieć typ custom i może mieć dowolną nazwę. Jeśli jest ustawiona wartość custom, customType musi też być ustawiona.

Akceptowane wartości: custom, mission, occupation, outlook.

keywords[].value

string

Słowo kluczowe.

deletionTime

string

Tylko dane wyjściowe. Godzina usunięcia konta użytkownika. Wartość jest podana w formacie ISO 8601, Godzina to pełna data wraz z liczbą godzin, minut i sekund w postaci 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

Czytelny dla użytkownika ciąg znaków zawierający właściwe sposoby odwoływania się do właściciela profilu, na przykład „on/jego/jego” lub „je/ich/ich”.

gender.customGender

string

Nazwa niestandardowej płci.

gender.type

string

Typ 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)

kont czatu. Konto użytkownika może mieć wiele usług ims, ale tylko jedna z nich może być główną osobą kontaktową w IM.

Pola

ims[].customProtocol

string

Jeśli wartość protokołu to custom_protocol, ta właściwość zawiera ciąg protokołu niestandardowego.

ims[].customType

string

Jeśli czat type ma wartość custom, ta właściwość zawiera wartość niestandardową i musi być ustawiona.

ims[].im

string

Identyfikator sieci IM użytkownika.

ims[].primary

boolean

Jeśli jest to główny komunikator użytkownika. Tylko jeden wpis na liście czatu może mieć wartość true.

ims[].protocol

string

Protokół IM określa sieć komunikatora. Może to być sieć niestandardowa lub standardowa.

Akceptowane wartości:
  • aim: protokół AOL 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 jest ustawiona wartość custom, customType musi też być ustawiona.

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. 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 najwyższego poziomu, jest reprezentowana jako ukośnik (/).

recoveryEmail

string

Adres pomocniczy użytkownika.

recoveryPhone

string

Pomocniczy numer telefonu użytkownika. Numer telefonu musi mieć format E.164, zaczynający się od znaku plusa (+). Na przykład: +16506661212.

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 przy tworzeniu konta użytkownika.

givenName

string

Imię użytkownika. Wymagane przy tworzeniu 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 listę użytkowników z podziałem na strony lub usuniętych z domeny wszystkich użytkowników.

makeAdmin

Oznacza, że użytkownik jest superadministratorem.

patch

Aktualizuje użytkownika za pomocą semantyki poprawki.

signOut

Wylogowuje użytkownika ze wszystkich sesji internetowych i na urządzeniach oraz resetuje pliki cookie logowania.

undelete

Cofa usunięcie usuniętego konta użytkownika.

update

Aktualizuje użytkownika.

watch

Czeka na zmiany na liście użytkowników.