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. Кроме того, значения имени поддерживают символы Юникода/UTF-8 и могут содержать пробелы, буквы (az), цифры (0–9), тире (-). , косая черта (/) и точки (.). Дополнительную информацию о правилах использования символов смотрите в справочном центре администрирования . Максимально допустимый размер данных для этого поля — 1 КБ.
kind	string Только вывод. Тип ресурса API. Для ресурсов пользователей значением является 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 запроса user.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 Если значение type является пользовательским, это свойство содержит пользовательский тип. organizations[].department string Указывает отдел внутри организации, например sales или engineering . organizations[].description string Описание организации. organizations[].domain string Домен, которому принадлежит организация. organizations[].fullTimeEquivalent integer Эквивалент полной занятости в миллипроценте внутри организации (100 000 = 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 Системный идентификатор, к которому применяется имя пользователя или 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) Учетные записи пользователя в мгновенных сообщениях (IM). Учетная запись пользователя может иметь несколько свойств ims , но только одно из этих свойств ims может быть основным контактом для обмена мгновенными сообщениями. Поля ims[].customProtocol string Если значение протокола — custom_protocol , это свойство содержит строку пользовательского протокола. ims[].customType string Если type IM — custom , это свойство содержит пользовательское значение и должно быть установлено. ims[].im string Идентификатор сети обмена мгновенными сообщениями пользователя. ims[].primary boolean Если это основной чат пользователя. Только одна запись в списке мгновенных сообщений может иметь значение true. ims[].protocol string Протокол IM идентифицирует сеть IM. Значением может быть пользовательская сеть или стандартная сеть. Допустимые значения: aim : протокол обмена мгновенными сообщениями AOL. custom_protocol : собственный сетевой протокол обмена мгновенными сообщениями. gtalk : протокол Google Talk. icq : протокол ICQ jabber : протокол Jabber msn : протокол MSN Messenger. net_meeting : протокол сетевого собрания. qq : протокол QQ skype : протокол скайпа yahoo : протокол Yahoo Messenger ims[].type string Тип учетной записи обмена мгновенными сообщениями. Если установлено значение 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	Отслеживает изменения в списке пользователей.