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,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  }
}
Поля
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 — совместим с библиотекой crypt на языке C. Поддерживает алгоритмы хеширования 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. Кроме того, значения имени поддерживают символы 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

Только вывод. Идентификатор клиента для получения всех пользователей учетной записи .
Для представления customerId вашей учетной записи можно использовать псевдоним my_customer .
В качестве администратора реселлера вы можете использовать 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

 Если значение параметра type равно custom, это свойство содержит пользовательский тип.

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

 Системный идентификатор, к которому относятся имя пользователя или 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

Только вывод. Электронный тег фотографии пользователя (только для чтения)

ims

value ( Value format)

Учетные записи пользователя в мессенджерах (IM). У одной учетной записи пользователя может быть несколько свойств ims , но только одно из этих ims может быть основным контактом в мессенджерах.

Поля

ims[].customProtocol

string

 Если значение параметра protocol равно custom_protocol , это свойство содержит строку пользовательского протокола.

ims[].customType

string

 Если type IM — custom , это свойство содержит пользовательское значение и должно быть установлено.

ims[].im

string

 Идентификатор сети мгновенных сообщений пользователя.

ims[].primary

boolean

 Если это основной канал мгновенных сообщений пользователя, то только одна запись в списке мгновенных сообщений может иметь значение true.

ims[].protocol

string

 Протокол обмена мгновенными сообщениями (IM) идентифицирует сеть обмена мгновенными сообщениями. Значением может быть пользовательская сеть или стандартная сеть.

Допустимые значения:
  • aim : протокол AOL Instant Messenger
  • custom_protocol : Пользовательский сетевой протокол для обмена мгновенными сообщениями.
  • gtalk : протокол Google Talk
  • icq : протокол ICQ
  • jabber : протокол Jabber
  • msn : протокол MSN Messenger
  • net_meeting : Протокол сетевого совещания
  • qq : протокол QQ
  • skype : протокол 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, начиная со знака плюс (+). Пример: +16506661212 .

isGuestUser

boolean

Неизменяемый параметр. Указывает, является ли пользователь гостем.

guestAccountInfo

object ( GuestAccountInfo )

Неизменяемые. Дополнительные поля метаданных, относящиеся к гостям.

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

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

string

Полное имя пользователя формируется путем объединения значений имени и фамилии.

familyName

string

Фамилия пользователя. Обязательно при создании учетной записи пользователя.

givenName

string

Имя пользователя. Обязательно при создании учетной записи пользователя.

displayName

string

Отображаемое имя пользователя. Ограничение: 256 символов.

Информация о гостевом аккаунте

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

JSON-представление 
{
  "primaryGuestEmail": string
}
Поля
primaryGuestEmail

string

Неизменяемый. Внешний адрес электронной почты гостя.

Методы

createGuest

 Создайте гостевого пользователя с доступом к ограниченному набору возможностей рабочей области .

delete

 Удаляет пользователя.

get

 Получает информацию о пользователе.

insert

 Создает пользователя.

list

 Получает постраничный список либо удаленных пользователей, либо всех пользователей в домене.

makeAdmin

 Предоставляет пользователю права суперадминистратора.

patch

 Обновляет данные пользователя, используя семантику патчей.

signOut

 Выводит пользователя из всех веб-сессий и сессий на устройстве и сбрасывает его файлы cookie для входа в систему.

undelete

 Восстанавливает удаленного пользователя.

update

 Обновляет данные пользователя.

watch

 Отслеживает изменения в списке пользователей.