REST Resource: users

Ресурс: Пользователь

API каталога позволяет вам создавать и управлять пользователями вашей учетной записи, псевдонимами пользователей и фотографиями профилей пользователей Google. Для получения дополнительной информации о распространенных задачах см. Руководство разработчика учетных записей пользователей и Руководство разработчика псевдонимов пользователей .

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 }

Поля
id	string Уникальный идентификатор пользователя. id пользователя может использоваться как userKey URI запроса пользователя.
primaryEmail	string Основной адрес электронной почты пользователя. Это свойство требуется в запросе на создание учетной записи пользователя. primaryEmail должен быть уникальным и не может быть псевдонимом другого пользователя.
password	value ( Value format) Сохраняет пароль для учетной записи пользователя. Значение пароля пользователя требуется при создании учетной записи пользователя. Оно необязательно при обновлении пользователя и должно предоставляться только в том случае, если пользователь обновляет пароль своей учетной записи. Значение пароля никогда не возвращается в теле ответа API. Пароль может содержать любую комбинацию символов ASCII и должен содержать от 8 до 100 символов. Мы рекомендуем отправлять параметр password как шестнадцатеричное кодированное хэш-значение и устанавливать hashFunction соответствующим образом. Если hashFunction указан, пароль должен быть действительным хэш-ключом.
hashFunction	string Сохраняет формат хеша свойства password . Разрешены следующие значения hashFunction : MD5 — принимает простые шестнадцатеричные значения. SHA-1 — принимает простые шестнадцатеричные значения. crypt - Совместимо с библиотекой C crypt . Поддерживает алгоритмы хеширования DES, MD5 (префикс хэша $1$ ), SHA-256 (префикс хэша $5$ ) и SHA-512 (префикс хэша $6$ ). Если в префиксе указаны раунды, их должно быть 10 000 или меньше.
isAdmin	boolean Только вывод. Указывает пользователя с привилегиями суперадминистратора. Свойство isAdmin можно редактировать только в операции « Сделать пользователя администратором» (метод makeAdmin ). Если редактирование выполняется в методах вставки или обновления пользователя, редактирование игнорируется службой API.
isDelegatedAdmin	boolean Только вывод. Указывает, является ли пользователь делегированным администратором. Делегированные администраторы поддерживаются API, но не могут создавать или отменять удаление пользователей или делать пользователей администраторами. Эти запросы игнорируются службой API. Роли и привилегии администраторов назначаются с помощью консоли администратора .
agreedToTerms	boolean Только вывод. Это свойство имеет true , если пользователь выполнил первоначальный вход и принял соглашение об условиях обслуживания.
suspended	boolean Указывает, заблокирован ли пользователь.
changePasswordAtNextLogin	boolean Указывает, должен ли пользователь сменить пароль при следующем входе в систему. Этот параметр не применяется, когда пользователь входит в систему через стороннего поставщика удостоверений .
ipWhitelisted	boolean Если true , IP-адрес пользователя попадает под устаревшую конфигурацию allowlist разрешенных IP-адресов.
name	object ( UserName ) Содержит имя и фамилию пользователя, а также значение fullName , доступное только для чтения. Максимальное количество символов в значениях givenName и familyName составляет 60. Кроме того, значения name поддерживают символы unicode/UTF-8 и могут содержать пробелы, буквы (az), цифры (0-9), тире (-), косые черты (/) и точки (.). Для получения дополнительной информации о правилах использования символов см. справочный центр по администрированию . Максимально допустимый размер данных для этого поля составляет 1 КБ.
kind	string Только вывод. Тип ресурса API. Для ресурсов Users значение admin#directory#user .
etag	string Только вывод. ETag ресурса.
emails	value ( Value format) Список адресов электронной почты пользователя. Максимально допустимый размер данных — 10 КБ. Поля emails[].address string Адрес электронной почты пользователя. Также служит идентификатором электронной почты. Это значение может быть основным адресом электронной почты пользователя или псевдонимом. emails[].customType string Если type адреса электронной почты — custom , это свойство содержит пользовательское значение и должно быть установлено. emails[].primary boolean Указывает, является ли это основным адресом электронной почты пользователя. Только одна запись может быть отмечена как основная. emails[].type string Тип учетной записи электронной почты. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: custom , home , other , work .
externalIds	value ( Value format) Список внешних идентификаторов пользователя, таких как идентификатор сотрудника или сети. Максимально допустимый размер данных — 2 КБ. Поля externalIds[].customType string Если type внешнего идентификатора — custom , это свойство содержит пользовательское значение и должно быть установлено. externalIds[].type string Тип внешнего идентификатора. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: account , custom , customer , login_id , network , organization . externalIds[].value string Значение внешнего идентификатора.
relations	value ( Value format) Список отношений пользователя с другими пользователями. Максимально допустимый размер данных для этого поля — 2 КБ. Для получения дополнительной информации см. Управление учетными записями пользователей . Поля relations[].customType string Если type связи — custom , это свойство содержит пользовательское значение и должно быть установлено. relations[].type string Тип отношения. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: 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 Адрес электронной почты человека, с которым связан пользователь.
aliases[]	string Только вывод. Список псевдонимов адресов электронной почты пользователя.
isMailboxSetup	boolean Только вывод. Указывает, создан ли почтовый ящик Google пользователя. Это свойство применимо только в том случае, если пользователю назначена лицензия Gmail.
customerId	string Только вывод. Идентификатор клиента для извлечения всех пользователей аккаунта . Вы можете использовать псевдоним my_customer для представления customerId вашей учетной записи. Как администратор реселлера, вы можете использовать customerId учетной записи перепроданного клиента. Чтобы получить customerId , используйте основной домен учетной записи в параметре domain запроса users.list .
addresses	value ( Value format) Список адресов пользователя. Максимально допустимый размер данных — 10КБ. Поля addresses[].country string Страна. addresses[].countryCode string Код страны. Использует стандарт ISO 3166-1 . addresses[].customType string Если type адреса — custom , это свойство содержит пользовательское значение и должно быть установлено. addresses[].extendedAddress string Для расширенных адресов, таких как адрес, включающий подрегион. addresses[].formatted string Полный и неструктурированный почтовый адрес. Он не синхронизируется с полями структурированного адреса. Включает следующие атрибуты: почтовый адрес, почтовый ящик, город, штат/провинция, почтовый индекс, страна/регион. addresses[].locality string Город, в котором указан адрес. addresses[].poBox string Почтовый ящик, если таковой имеется. addresses[].postalCode string Почтовый индекс, если применимо. addresses[].primary boolean Если это основной адрес пользователя. Список адресов может содержать только один основной адрес. addresses[].region string Сокращенное название провинции или штата. addresses[].sourceIsStructured boolean Указывает, был ли отформатирован предоставленный пользователем адрес. Отформатированные адреса в настоящее время не поддерживаются. addresses[].streetAddress string Почтовый адрес, например, 1600 Amphitheatre Parkway . Пробелы внутри строки игнорируются; однако символы новой строки имеют значение. addresses[].type string Тип адреса. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: custom , home , other , work .
organizations	value ( Value format) Список организаций, к которым принадлежит пользователь. Максимально допустимый размер данных — 10 КБ. Поля organizations[].costCenter string Центр затрат организации пользователя. organizations[].customType string Если значение типа — пользовательский, это свойство содержит пользовательский тип. organizations[].department string Указывает отдел в организации, например sales или engineering . organizations[].description string Описание организации. organizations[].domain string Домен, к которому принадлежит организация. organizations[].fullTimeEquivalent integer Эквивалент полной занятости в миллипроцентах внутри организации (100000 = 100%). organizations[].location string Физическое местонахождение организации. Это не обязательно должен быть полностью определенный адрес. organizations[].name string Название организации. organizations[].primary boolean Указывает, является ли это основной организацией пользователя. У пользователя может быть только одна основная организация. organizations[].symbol string Текстовая строка символа организации. Например, текстовый символ для Google — GOOG . organizations[].title string Должность пользователя в организации. Например, member или engineer . organizations[].type string Тип организации. Допустимые значения: domain_only , school , unknown , work .
lastLoginTime	string Только вывод. Последнее время, когда пользователь входил в учетную запись пользователя. Значение в формате даты и времени ISO 8601. Время — это полная дата плюс часы, минуты и секунды в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 .
phones	value ( Value format) Список телефонных номеров пользователя. Максимально допустимый размер данных — 1 КБ. Поля phones[].customType string Если type номера телефона — custom , это свойство содержит пользовательское значение и должно быть установлено. phones[].primary boolean Если true , это основной номер телефона пользователя. У пользователя может быть только один основной номер телефона. phones[].type string Тип номера телефона. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: 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 Номер телефона, понятный человеку. Может быть в любом формате телефонного номера.
suspensionReason	string Только вывод. Имеет причину, по которой аккаунт пользователя был приостановлен администратором или Google на момент приостановки. Свойство возвращается только в том случае, если suspended свойство имеет значение true .
thumbnailPhotoUrl	string Только вывод. URL-адрес фотографии профиля пользователя. URL-адрес может быть временным или частным.
languages	value ( Value format) Список языков пользователя. Максимально допустимый размер данных — 1КБ. Поля languages[].customLanguage string Другой язык. Пользователь может указать свое собственное название языка, если нет соответствующего кода языка ISO 639. Если он установлен, languageCode не может быть установлен. languages[].languageCode string Строковое представление языка в формате ISO 639. Список поддерживаемых кодов см. в разделе Коды языков . Допустимые коды языков, не входящие в поддерживаемый набор, будут приняты API, но могут привести к неожиданному поведению. Недопустимые значения вызывают SchemaException . Если это установлено, customLanguage не может быть установлено. languages[].preference string Необязательно. Если присутствует, контролирует, является ли указанный languageCode предпочтительным языком пользователя. Если задано customLanguage , это не может быть установлено. Допустимые значения — preferred и not_preferred .
posixAccounts	value ( Value format) Список данных учетной записи POSIX для пользователя. Поля posixAccounts[].accountId string Идентификатор поля учетной записи POSIX. posixAccounts[].gecos string GECOS (информация о пользователе) для этой учетной записи. posixAccounts[].gid unsigned long Идентификатор группы по умолчанию. posixAccounts[].homeDirectory string Путь к домашнему каталогу этой учетной записи. posixAccounts[].operatingSystemType string Тип операционной системы для этой учетной записи. Допустимые значения: linux , unspecified , windows . posixAccounts[].primary boolean Если это основная учетная запись пользователя в SystemId. posixAccounts[].shell string Путь к оболочке входа для этой учетной записи. posixAccounts[].systemId string Системный идентификатор, к которому относится учетная запись Username или Uid. posixAccounts[].uid unsigned long Идентификатор пользователя, совместимый с POSIX. posixAccounts[].username string Имя пользователя учетной записи.
creationTime	string Только вывод. Время создания учетной записи пользователя. Значение в формате даты и времени ISO 8601. Время — это полная дата плюс часы, минуты и секунды в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 .
nonEditableAliases[]	string Только вывод. Список нередактируемых псевдонимов адресов электронной почты пользователя. Обычно они находятся за пределами основного домена или поддомена учетной записи.
sshPublicKeys	value ( Value format) Список открытых ключей SSH. Поля sshPublicKeys[].expirationTimeUsec long Время истечения срока действия в микросекундах с начала эпохи. sshPublicKeys[].fingerprint string Отпечаток SHA-256 открытого ключа SSH. (Только для чтения) sshPublicKeys[].key string Открытый ключ SSH.
notes	value ( Value format) Заметки для пользователя как вложенный объект. Поля notes.contentType string Тип содержимого заметки, либо простой текст, либо HTML. По умолчанию — простой текст. Допустимые значения: text_plain , text_html . notes.value string Содержание заметок.
websites	value ( Value format) Список веб-сайтов пользователя. Поля websites[].customType string Если type веб-сайта — custom , это свойство содержит пользовательское значение и должно быть установлено. websites[].primary boolean Если true , это основной веб-сайт пользователя. websites[].type string Тип или цель веб-сайта. Например, веб-сайт может быть помечен как home или blog . В качестве альтернативы запись может иметь custom тип. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: app_install_page , blog , custom , ftp , home , home_page , other , profile , reservations , resume , work . websites[].value string URL-адрес веб-сайта.
locations	value ( Value format) Список местоположений пользователя. Максимально допустимый размер данных — 10 КБ. Поля locations[].area string Текстовое местоположение. Это наиболее полезно для отображения, чтобы кратко описать местоположение. Например, Mountain View, CA или Near Seattle . locations[].buildingId string Идентификатор здания. locations[].customType string Если type местоположения — custom , это свойство содержит пользовательское значение и должно быть установлено. locations[].deskCode string Наиболее точный текстовый код местоположения отдельного стола. locations[].floorName string Название/номер этажа. locations[].floorSection string Раздел пола. Более конкретное местоположение на этаже. Например, если этаж разделен на разделы A , B и C , это поле будет определять одно из этих значений. locations[].type string Тип местоположения. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: custom , default , desk .
includeInGlobalAddressList	boolean Указывает, отображается ли профиль пользователя в глобальном списке адресов Google Workspace, когда для домена включена функция обмена контактами. Для получения дополнительной информации об исключении профилей пользователей см. справочный центр по администрированию .
keywords	value ( Value format) Список ключевых слов пользователя. Максимально допустимый размер данных — 1КБ. Поля keywords[].customType string Если type ключевого слова — custom , это свойство содержит пользовательское значение и должно быть установлено. keywords[].type string Каждая запись может иметь тип, который указывает стандартный тип этой записи. Например, ключевое слово может быть типа occupation или outlook . В дополнение к стандартному типу запись может иметь custom тип и может дать ему любое имя. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: custom , mission , occupation , outlook . keywords[].value string Ключевое слово.
deletionTime	string Только вывод. Время удаления учетной записи пользователя. Значение в формате даты и времени ISO 8601. Время — это полная дата плюс часы, минуты и секунды в формате YYYY-MM-DDThh:mm:ssTZD . Например, 2010-04-05T17:30:04+01:00 .
gender	value ( Value format) Вложенный объект, содержащий пол пользователя. Максимально допустимый размер данных для этого поля — 1 КБ. Поля gender.addressMeAs string Строка, понятная человеку, содержащая правильный способ обращения к владельцу профиля, например, «он/его/его» или «они/их/их». gender.customGender string Название пользовательского пола. gender.type string Тип пола. Допустимые значения: female male other unknown
thumbnailPhotoEtag	string Только вывод. ETag фотографии пользователя (Только для чтения)
ims	value ( Value format) Учетные записи пользователя Instant Messenger (IM). Учетная запись пользователя может иметь несколько свойств ims , но только одно из этих свойств ims может быть основным контактом IM. Поля ims[].customProtocol string Если значение протокола — custom_protocol , это свойство содержит строку пользовательского протокола. ims[].customType string Если type IM — custom , это свойство содержит пользовательское значение и должно быть установлено. ims[].im string Идентификатор сети IM пользователя. ims[].primary boolean Если это основной IM пользователя. Только одна запись в списке IM может иметь значение true. ims[].protocol string Протокол обмена мгновенными сообщениями определяет сеть обмена мгновенными сообщениями. Значение может быть пользовательской сетью или стандартной сетью. Допустимые значения: aim : протокол AOL Instant Messenger custom_protocol : Пользовательский сетевой протокол обмена мгновенными сообщениями gtalk : протокол Google Talk icq : протокол ICQ jabber : Протокол Jabber msn : протокол MSN Messenger net_meeting : протокол Net Meeting qq : протокол QQ skype : протокол скайпа yahoo : Протокол Yahoo Messenger ims[].type string Тип учетной записи IM. Если установлено значение custom , customType также должен быть установлен. Допустимые значения: custom , home , other , work .
customSchemas	value ( Value format) Пользовательские поля пользователя. Ключом является schemaName , а его значениями являются 'fieldName': 'field_value' . customSchemas.(key) — вложенный объект. customSchemas.(key).(key) может иметь любое значение.
isEnrolledIn2Sv	boolean Только вывод. Зарегистрирован в двухэтапной верификации (только для чтения)
isEnforcedIn2Sv	boolean Только вывод. Применяется ли двухэтапная верификация (только для чтения)
archived	boolean Указывает, находится ли пользователь в архиве.
orgUnitPath	string Полный путь родительской организации, связанной с пользователем. Если родительская организация находится на верхнем уровне, она представлена ​​в виде косой черты ( / ).
recoveryEmail	string Резервный адрес электронной почты пользователя.
recoveryPhone	string Резервный телефон пользователя. Номер телефона должен быть в формате E.164, начинаться со знака плюс (+). Пример: [phone] .

Имя пользователя

JSON-представление
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

Поля
fullName	string Полное имя пользователя, образованное путем объединения значений имени и фамилии.
familyName	string Фамилия пользователя. Требуется при создании учетной записи пользователя.
givenName	string Имя пользователя. Требуется при создании учетной записи пользователя.
displayName	string Отображаемое имя пользователя. Ограничение: 256 символов.

Методы
delete	Удаляет пользователя.
get	Извлекает пользователя.
insert	Создает пользователя.
list	Извлекает постраничный список удаленных пользователей или всех пользователей в домене.
makeAdmin	Делает пользователя суперадминистратором.
patch	Обновляет пользователя, используя семантику патча.
signOut	Выполняет выход пользователя из всех веб-сеансов и сеансов на устройстве и сбрасывает файлы cookie входа.
undelete	Восстанавливает удаленного пользователя.
update	Обновляет пользователя.
watch	Отслеживает изменения в списке пользователей.