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 ( |
Pola | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Unikalny identyfikator użytkownika. Użytkownika |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
Podstawowy adres e-mail użytkownika. Ta właściwość jest wymagana w żądaniu utworzenia konta użytkownika. |
||||||||||||||||||||||||||||||||||||||||||
password |
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. |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
Zapisuje format skrótu właściwości
Jeśli prefiks jest określony w przypadku rund, nie może on przekraczać 10 000. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
Tylko dane wyjściowe. Wskazuje użytkownika z uprawnieniami superadministratora. Właściwość |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
Tylko dane wyjściowe. Wskazuje, czy użytkownik jest administratorem delegowanym. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
Tylko dane wyjściowe. Ta usługa to |
||||||||||||||||||||||||||||||||||||||||||
suspended |
Wskazuje, czy konto użytkownika jest zawieszone. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
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 |
W przypadku zasady |
||||||||||||||||||||||||||||||||||||||||||
name |
Zawiera imiona i nazwiska użytkowników oraz wartość |
||||||||||||||||||||||||||||||||||||||||||
kind |
Tylko dane wyjściowe. Typ zasobu interfejsu API. W przypadku zasobów użytkowników wartość to |
||||||||||||||||||||||||||||||||||||||||||
etag |
Tylko dane wyjściowe. ETag zasobu. |
||||||||||||||||||||||||||||||||||||||||||
emails |
Lista adresów e-mail użytkownika. Maksymalny dozwolony rozmiar danych to 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
Lista identyfikatorów zewnętrznych użytkownika, na przykład identyfikatora pracownika czy sieci. Maksymalny dozwolony rozmiar danych to 2 KB.
|
||||||||||||||||||||||||||||||||||||||||||
relations |
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.
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
Tylko dane wyjściowe. Lista aliasów adresów e-mail użytkowników. |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
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 |
Tylko dane wyjściowe. Identyfikator klienta, który służy do pobierania wszystkich użytkowników konta. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
Lista adresów użytkownika. Maksymalny dozwolony rozmiar danych to 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
Lista organizacji, do których należy użytkownik. Maksymalny dozwolony rozmiar danych to 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
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 |
||||||||||||||||||||||||||||||||||||||||||
phones |
Lista numerów telefonów użytkownika. Maksymalny dozwolony rozmiar danych to 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
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ść |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
Tylko dane wyjściowe. Adres URL zdjęcia profilowego użytkownika. Adres URL może być tymczasowy lub prywatny. |
||||||||||||||||||||||||||||||||||||||||||
languages |
Lista języków użytkownika. Maksymalny dozwolony rozmiar danych to 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
Lista informacji o koncie POSIX użytkownika.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
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 |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
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 |
Lista kluczy publicznych SSH.
|
||||||||||||||||||||||||||||||||||||||||||
notes |
Uwagi użytkownika jako obiekt zagnieżdżony.
|
||||||||||||||||||||||||||||||||||||||||||
websites |
Lista stron internetowych użytkownika.
|
||||||||||||||||||||||||||||||||||||||||||
locations |
Lista lokalizacji użytkownika. Maksymalny dozwolony rozmiar danych to 10 KB.
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
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 |
Lista słów kluczowych użytkownika. Maksymalny dozwolony rozmiar danych to 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
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 |
||||||||||||||||||||||||||||||||||||||||||
gender |
Zagnieżdżony obiekt zawierający płeć użytkownika. Maksymalny dozwolony rozmiar danych w tym polu to 1 KB.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
Tylko dane wyjściowe. ETag zdjęcia użytkownika (tylko do odczytu) |
||||||||||||||||||||||||||||||||||||||||||
ims |
kont czatu. Konto użytkownika może mieć wiele usług
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
Pola niestandardowe użytkownika. Klucz to
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
Tylko dane wyjściowe. Jest zarejestrowany w systemie weryfikacji dwuetapowej (tylko do odczytu) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
Tylko dane wyjściowe. Czy wymuszana jest weryfikacja dwuetapowa (tylko do odczytu) |
||||||||||||||||||||||||||||||||||||||||||
archived |
Wskazuje, czy konto użytkownika zostało zarchiwizowane. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
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 |
Adres pomocniczy użytkownika. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
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 |
Imię i nazwisko użytkownika utworzone przez połączenie wartości imienia i nazwiska użytkownika. |
familyName |
Nazwisko użytkownika. Wymagane przy tworzeniu konta użytkownika. |
givenName |
Imię użytkownika. Wymagane przy tworzeniu konta użytkownika. |
displayName |
Wyświetlana nazwa użytkownika. Limit: 256 znaków. |
Metody |
|
---|---|
|
Usuwa użytkownika. |
|
Pobiera użytkownika. |
|
Utworzenie użytkownika. |
|
Pobiera treści podzielonej na strony z usuniętymi lub wszystkimi kontami użytkowników w domenie. |
|
Określa, czy użytkownik jest superadministratorem. |
|
Aktualizuje dane użytkownika za pomocą semantyki poprawki. |
|
Wylogowuje użytkownika ze wszystkich sesji internetowych i na urządzeniu oraz resetuje pliki cookie logowania. |
|
Cofanie usunięcia usuniętego konta użytkownika. |
|
Aktualizuje użytkownika. |
|
Oczekiwanie na zmiany na liście użytkowników. |