REST Resource: users

Zasób: Użytkownik

Interfejs Directory API umożliwia tworzenie użytkowników na koncie, ich aliasów i zdjęć profilowych na koncie Google oraz zarządzanie nimi. Więcej informacji o popularnych zadaniach znajdziesz w przewodniku dla programistów na temat kont użytkowników i przewodniku dla programistów na temat 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. Jako userKey w identyfikatorze URI żądania użytkownika można użyć adresu id 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. Wartość hasła użytkownika jest wymagana podczas tworzenia konta użytkownika. 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ć od 8 do 100 znaków.

Zalecamy wysyłanie parametru password jako wartości skrótu zaszyfrowanej w sposób szesnastkowy i odpowiednie ustawienie parametru hashFunction. Jeśli podano wartość hashFunction, hasło musi być prawidłowym kluczem haszowania.
hashFunction

string

Przechowuje format hasha właściwości password. Dozwolone są następujące wartości hashFunction:

  • MD5 – Akceptuje proste wartości zakodowane w szesnastkowym systemie liczbowym.
  • 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 w prefiksie występują zaokrąglenia, muszą one być równe co najmniej 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 edytujesz go w metodach insert lub update, usługa interfejsu API go zignoruje.
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 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 wycofanej konfiguracji 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. Wartości nazw mogą też zawierać znaki Unicode/UTF-8, spacje, litery (a–z), cyfry (0–9), łączniki (-), ukośniki (/) i kropki (.). Więcej informacji o zasadach dotyczących znaków znajdziesz w Centrum pomocy 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 Użytkownicy 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 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, np. identyfikator pracownika lub identyfikator 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 niestandardową wartość i musi być ustawiona.

externalIds[].type

string

Typ identyfikatora zewnętrznego. Jeśli ustawisz wartość custom, musisz też ustawić wartość customType.

Dopuszczalne 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 to custom, ta właściwość zawiera wartość niestandardową i musi zostać ustawiona.

relations[].type

string

Typ relacji. Jeśli ustawisz wartość custom, musisz też ustawić 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 adresów e-mail użytkownika.
isMailboxSetup

boolean

Tylko dane wyjściowe. Wskazuje, czy skrzynka pocztowa Google użytkownika została utworzona. Ta usługa jest dostępna tylko wtedy, gdy użytkownik ma przypisaną licencję na Gmaila.
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órego dotyczy sprzedaż. 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

rozszerzone adresy, np. adresy zawierające podregion.

addresses[].formatted

string

Pełny i nieustrukturyzowany adres pocztowy. Nie jest ono synchronizowane z uporządkowanymi polami adresu. Zawiera te atrybuty: adres, skrytka pocztowa, miasto, województwo, kod pocztowy, kraj.

addresses[].locality

string

Miejscowość, w której znajduje się adres.

addresses[].poBox

string

Numer skrytki pocztowej, jeśli taka występuje.

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 1 adres główny.

addresses[].region

string

Skrócona nazwa prowincji lub województwa.

addresses[].sourceIsStructured

boolean

Wskazuje, czy adres podany przez użytkownika został sformatowany. Formatowane adresy nie są obecnie obsługiwane.

addresses[].streetAddress

string

Ulica i numer, na przykład 1600 Amphitheatre Parkway. Białe znaki w ciągu są ignorowane, ale znaki nowego wiersza są istotne.

addresses[].type

string

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

Dopuszczalne 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

pełnoetatowe zatrudnienie w ujęciu ‰ w organizacji (100 000 = 100%).

organizations[].location

string

Fizyczna lokalizacja organizacji. Nie musi to być w pełni kwalifikowany 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

Tekstowy ciąg znaków symbolizujący organizację. 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. Czas ostatniego logowania na konto 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.
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 niestandardową wartość i musi być ustawiona.

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 ustawiona jest wartość custom, musi być też ustawiona wartość customType.

Dopuszczalne 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 zrozumiały dla człowieka. Może to być dowolny format 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. 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 odpowiedniego kodu języka w formacie ISO 639, użytkownik może podać własną nazwę języka. Jeśli to ustawienie jest włączone, nie można ustawić wartości languageCode.

languages[].languageCode

string

Reprezentacja języka w formie ciągu znaków ISO 639. 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 spowodować nieoczekiwane działanie. Nieprawidłowe wartości powodują SchemaException. Jeśli to ustawienie jest włączone, nie można ustawić wartości customLanguage.

languages[].preference

string

Opcjonalnie: Jeśli jest obecny, określa, czy określony język languageCode jest preferowanym językiem użytkownika. Jeśli ustawiono wartość 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) dla tego konta.

posixAccounts[].gid

unsigned long

Domyślny identyfikator grupy.

posixAccounts[].homeDirectory

string

Ścieżka do katalogu domowego tego konta.

posixAccounts[].operatingSystemType

string

Typ systemu operacyjnego dla tego konta.

Akceptowane wartości: linux, unspecified oraz windows.

posixAccounts[].primary

boolean

Czy jest to główne konto użytkownika w SystemId.

posixAccounts[].shell

string

Ścieżka do powłoki logowania na tym koncie.

posixAccounts[].systemId

string

Identyfikator systemu, do którego odnoszą 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 na koncie.
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 nieedytowalnych aliasów adresów e-mail użytkownika. Są to zazwyczaj spoza domeny podstawowej lub subdomeny 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 dla użytkownika jako obiekt zagnieżdżony.

Pola

notes.contentType

string

Typ treści notatki: zwykły tekst lub kod 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 wartość właściwości witryny type to custom, ta właściwość zawiera niestandardową wartość i musi być ustawiona.

websites[].primary

boolean

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

websites[].type

string

Typ lub przeznaczenie witryny. Na przykład witryna może mieć etykietę home lub blog. Może on mieć też 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. 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 niestandardową wartość i musi być ustawiona.

locations[].deskCode

string

Najdokładniejszy kod tekstowy określający położenie biurka.

locations[].floorName

string

Nazwa lub numer piętra.

locations[].floorSection

string

Sekcja piętra. bardziej szczegółowa lokalizacja na piętrze; Jeśli na przykład piętro jest podzielone na sekcje A, B i C, to pole będzie zawierać jedną z tych wartości.

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 włączona jest 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 niestandardową wartość 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 mieć typ occupation lub outlook. Oprócz typu standardowego wpis może mieć typ custom i nadać mu dowolną nazwę. Jeśli ustawiona jest wartość custom, musi być też ustawiona wartość 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 odpowiednie sposoby odniesienia się przez ludzi do właściciela profilu, na przykład „on/jego” lub „on/jego/ich”.

gender.customGender

string

Nazwa płci niestandardowej.

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)

konta użytkownika w komunikatorze błyskawicznym; Konto użytkownika może mieć wiele usług ims, ale tylko jedna z tych usług ims może być głównym kontaktem w usłudze przesyłania wiadomości błyskawicznych.

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 wartość IM type to custom, ta właściwość zawiera niestandardową wartość i musi być skonfigurowana.

ims[].im

string

Identyfikator sieci czatu użytkownika.

ims[].primary

boolean

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

ims[].protocol

string

 Protokół IM identyfikuje sieć IM. Wartością może 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 czatu. 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. Kluczem jest schemaName, a jego wartości to 'fieldName': 'field_value'.

  • customSchemas.(key) to obiekt zagnieżdżony.
  • customSchemas.(key).(key) może być dowolną wartością.
isEnrolledIn2Sv

boolean

Tylko dane wyjściowe. jest zarejestrowany w systemie weryfikacji dwuetapowej (tylko do odczytu);
isEnforcedIn2Sv

boolean

Tylko dane wyjściowe. Czy weryfikacja dwuetapowa jest wymuszona (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 reprezentowana przez 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 zaczynać się od znaku plusa (+). Przykład: +16506661212.

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. Wymagany podczas tworzenia konta użytkownika.
givenName

string

Imię użytkownika. Wymagany podczas tworzenia konta użytkownika.
displayName

string

Wyświetlana nazwa użytkownika. Limit: 256 znaków.

Metody

delete

 Usuwanie użytkownika.

get

 Pobiera użytkownika.

insert

 Tworzy użytkownika.

list

 Pobiera pogrupowaną listę usuniętych użytkowników lub wszystkich użytkowników w domenie.

makeAdmin

 Ustawia użytkownika jako superadministratora.

patch

 Aktualizuje użytkownika za pomocą semantyki poprawki.

signOut

 Wyloguje użytkownika ze wszystkich sesji w przeglądarce i na urządzeniach oraz resetuje jego pliki cookie logowania.

undelete

 przywraca usunięte konto użytkownika;

update

 Aktualizuje użytkownika.

watch

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