REST Resource: users

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

Zasób: User

Directory API pozwala tworzyć użytkowników kont, aliasy i zdjęcia profilowe użytkowników czatu w Gmailu oraz zarządzać 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
}
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 żądaniu utworzenia konta użytkownika. primaryEmail 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 użytkownika. Jest ona opcjonalna podczas aktualizowania informacji o użytkowniku i powinna być podawana tylko wtedy, gdy aktualizuje on 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. Musi mieć od 8 do 100 znaków.

Zalecamy wysłanie parametru password jako zakodowanej szesnastkowo wartości hash i odpowiednie ustawienie hashFunction. Jeśli jest określona 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 – musi być zgodna z biblioteką kryptograficzną C. Obsługuje algorytmy szyfrowania DES, MD5 (prefiks $1$), SHA-256 (szyfrowanie $5$) i SHA-512 (hasła z prefiksem $6$).

Jeśli prefiks jest określony w przypadku rund, nie może on 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 Przypisywanie użytkownikowi roli administratora ( metoda makeAdmin). Jeśli zostaną zmienione w metodzie insert lub update użytkownika, zostaną zignorowane 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 usuwać użytkowników ani ustawiać ich jako administratorów. Te żądania są ignorowane przez interfejs API.
Role i uprawnienia administratorów są przypisywane w konsoli administracyjnej.
agreedToTerms

boolean

Tylko dane wyjściowe. Ta usługa to true, jeśli użytkownik ukończył 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 będzie musiał zmienić hasło przy następnym logowaniu. To ustawienie nie ma zastosowania, gdy użytkownik loguje się przy użyciu zewnętrznego dostawcy tożsamości.
ipWhitelisted

boolean

W przypadku zasady true adres IP użytkownika podlega wycofanej konfiguracji adresu IP allowlist.
name

object (UserName)

Zawiera imiona i nazwiska użytkowników oraz wartość fullName tylko do odczytu. Maksymalna liczba znaków w wartościach givenName i familyName to 60. Dodatkowo nazwy mogą zawierać 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żytkowania znaków znajdziesz w Centrum pomocy administracyjnej. 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 podstawowy adres e-mail użytkownika. Tylko jeden wpis można oznaczyć jako główny.

emails[].type

string

Typ konta e-mail. Wartość custom musi też mieć wartość customType.

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

value (Value format)

Lista identyfikatorów zewnętrznych użytkownika, na przykład identyfikatora pracownika czy 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ą, więc trzeba ją ustawić.

externalIds[].type

string

Typ identyfikatora zewnętrznego. Wartość custom musi też mieć 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 do innych użytkowników. 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ą, więc trzeba ją ustawić.

relations[].type

string

Typ relacji. Jeśli zasada ma wartość custom, musi też być 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 aliasów adresów e-mail użytkowników.
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ę na Gmaila.
customerId

string

Tylko dane wyjściowe. Identyfikator klienta, który służy do pobierania wszystkich użytkowników konta.
Użyj aliasu my_customer, aby określić customerId na swoim koncie.
Jako administrator możesz używać numeru customerId sprzedawanego konta klienta. Aby uzyskać żądanie 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ą, którą trzeba ustawić.

addresses[].extendedAddress

string

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

addresses[].formatted

string

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

addresses[].locality

string

Miasto (lub miejscowość).

addresses[].poBox

string

Adres skrytki pocztowej.

addresses[].postalCode

string

Kod pocztowy, jeśli jest wymagany.

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

Ulica, np. 1600 Amphitheatre Parkway. Odstępy w ciągu znaków są ignorowane, ale znaki nowego wiersza mają znaczenie.

addresses[].type

string

Typ adresu. Wartość custom musi też mieć 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.

organizations[].customType

string

Jeśli wartość typu „typ” jest niestandardowa, ta właściwość zawiera wartość „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

Równoważnik pełnoetatowy 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ę podstawową.

organizations[].symbol

string

Symbol ciągu tekstowego organizacji. Na przykład symbolem tekstowym Google jest 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. Data ostatniego logowania użytkownika na jego konto. Wartość jest podana w formacie ISO 8601. Godzina to pełna data wraz z godziną, minutami i sekundami 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ć ustawiona.

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 ustawiona jest wartość custom, należy też ustawić 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_fax

phones[].value

string

Czytelny numer telefonu. Może on być w dowolnym formacie.
suspensionReason

string

Tylko dane wyjściowe. Czy informacje o przyczynie zawieszenia konta użytkownika zostały 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 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 ISO 639. Jeśli jest ustawiona, nie można ustawić languageCode.

languages[].languageCode

string

Symbol języka w formacie 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 jest ustawiona, nie można ustawić customLanguage.

languages[].preference

string

Opcjonalnie. Jeśli ta opcja jest dostępna, określa, czy określony język languageCode jest preferowanym językiem 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

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 polu SystemId.

posixAccounts[].shell

string

Ścieżka do powłoki logowania na to konto.

posixAccounts[].systemId

string

Identyfikator systemu, którego dotyczy nazwa użytkownika lub identyfikator UID 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. Wartość jest podana w formacie ISO 8601. Godzina to pełna data wraz z godziną, minutami i sekundami 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 użytkowników, których nie można edytować. Zwykle znajdują się one poza domeną podstawową lub subdomeną konta.
sshPublicKeys

value (Value format)

Lista kluczy publicznych SSH.

Pola

sshPublicKeys[].expirationTimeUsec

long

Czas ważności 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 notatki: zwykły tekst lub HTML. Wartość domyślna to zwykły tekst.

Akceptowane wartości: text_plain, text_html.

notes.value

string

Zawartość notatek.
websites

value (Value format)

Lista stron internetowych użytkownika.

Pola

websites[].customType

string

Jeśli witryna type ma wartość custom, ta właściwość zawiera wartość niestandardową, którą trzeba ustawić.

websites[].primary

boolean

Jeśli jest to true, jest to podstawowa witryna użytkownika.

websites[].type

string

Typ lub cel witryny. Na przykład witryna może zostać oznaczona jako home lub blog. Wpis może też mieć typ custom. Wartość custom musi też mieć wartość customType.

Dozwolone 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 jest najbardziej przydatna przy wyświetlaniu informacji, które pozwalają 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 biura.

locations[].floorName

string

Nazwa/numer piętra.

locations[].floorSection

string

piętra. Bardziej szczegółowa lokalizacja w piętrze. Jeśli na przykład piętro jest podzielone na sekcje A, B i C, to pole wskaże jedną z tych wartości.

locations[].type

string

Typ lokalizacji. Wartość custom musi też mieć wartość 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ą, więc trzeba ją ustawić.

keywords[].type

string

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

Przykładem słowa kluczowego może być occupation lub outlook. Oprócz standardowego typu wpis może zawierać typ custom i nadawać mu dowolną nazwę. Wartość custom musi też mieć wartość customType.

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 godziną, minutami i sekundami 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

Czytelny dla użytkownika ciąg znaków zawierający w odpowiedni sposób sposób odwołania się do właściciela profilu, na przykład „on/jego/jego” lub „je/jego/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 ims może być główną osobą kontaktową w komunikatorze.

Pola

ims[].customProtocol

string

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

ims[].customType

string

Jeśli komunikator type ma wartość custom, ta właściwość zawiera wartość niestandardową, którą trzeba ustawić.

ims[].im

string

Identyfikator sieci komunikatora użytkownika.

ims[].primary

boolean

Jest to główny komunikator użytkownika. Tylko jeden wpis na liście w komunikatorze może mieć wartość prawda.

ims[].protocol

string

 Protokół IM określa sieć czatu. Wartością może być sieć niestandardowa lub standardowa.

Akceptowane wartości:
  • aim: protokół AOL AOL Chat
  • custom_protocol: niestandardowy protokół sieci komunikatora
  • gtalk: protokół Google Talk
  • icq: protokół ICQ
  • jabber: Protokół Jabber
  • msn: protokół MSN Messenger
  • net_meeting: protokół spotkania wideo
  • qq: protokół QQ
  • skype: protokół Skype
  • yahoo: protokół Yahoo Messenger

ims[].type

string

Typ konta komunikatora. Wartość custom musi też mieć 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. Jest zarejestrowany w systemie weryfikacji dwuetapowej (tylko do odczytu)
isEnforcedIn2Sv

boolean

Tylko dane wyjściowe. Czy wymuszana jest weryfikacja dwuetapowa (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 najwyższego poziomu, jest ona 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 (+). Przykład: +16506661212.

Nazwa użytkownika

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

 Utworzenie użytkownika.

list

 Pobiera treści podzielonej na strony z usuniętymi lub wszystkimi kontami użytkowników w domenie.

makeAdmin

 Określa, czy użytkownik jest superadministratorem.

patch

 Aktualizuje dane użytkownika za pomocą semantyki poprawki.

signOut

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

undelete

 Cofanie usunięcia usuniętego konta użytkownika.

update

 Aktualizuje użytkownika.

watch

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