Admin SDK: Directory API

API каталога Admin SDK позволяет администраторам корпоративных доменов просматривать и управлять пользователями, группами, устройствами и связанными ресурсами своей организации. API Cloud Identity предлагают дополнительные способы управления некоторыми из этих ресурсов.

Сервис: admin.googleapis.com

Для вызова этой службы мы рекомендуем использовать клиентские библиотеки, предоставляемые Google. Если вашему приложению необходимо использовать собственные библиотеки для вызова этой службы, используйте следующую информацию при отправке запросов к API.

Документ об обнаружении

Документ Discovery — это машиночитаемая спецификация для описания и использования REST API. Он используется для создания клиентских библиотек, плагинов для IDE и других инструментов, взаимодействующих с API Google. Один сервис может предоставлять несколько документов Discovery. Данный сервис предоставляет следующий документ Discovery:

конечная точка сервиса

Конечная точка сервиса — это базовый URL-адрес, указывающий сетевой адрес API-сервиса. Один сервис может иметь несколько конечных точек. Данный сервис имеет следующую конечную точку, и все приведенные ниже URI являются относительными к этой конечной точке:

  • https://admin.googleapis.com

REST-ресурс: asps

Методы
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
Удаляет ASP-запрос, созданный пользователем.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
Получает информацию об ASP-сообщении, выпущенном пользователем.
list GET /admin/directory/v1/users/{userKey}/asps
Отображает список ASP-пакетов, выпущенных пользователем.

REST-ресурс: chromeosdevices

Методы
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
Вместо этого используйте BatchChangeChromeOsDeviceStatus .
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Получает свойства устройства Chrome OS.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
Получает постраничный список устройств Chrome OS в рамках учетной записи.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
Перемещает или вставляет несколько устройств Chrome OS в организационное подразделение.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Обновляет обновляемые свойства устройства, такие как annotatedUser , annotatedLocation , notes , orgUnitPath или annotatedAssetId .
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Обновляет обновляемые свойства устройства, такие как annotatedUser , annotatedLocation , notes , orgUnitPath или annotatedAssetId .

REST-ресурс: customer.devices.chromeos

Методы
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
Изменяет статус группы устройств ChromeOS.
countChromeOsDevices GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices
Подсчитывает количество устройств ChromeOS, соответствующих запросу.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
Выдает команду устройству для выполнения.

REST-ресурс: customer.devices.chromeos.commands

Методы
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
Получает данные команды, выданной устройству.

REST-ресурс: клиенты

Методы
get GET /admin/directory/v1/customers/{customerKey}
Находит клиента.
patch PATCH /admin/directory/v1/customers/{customerKey}
Обновляет соединение с клиентом.
update PUT /admin/directory/v1/customers/{customerKey}
Предоставляет информацию клиенту.

REST-ресурс: domainAliases

Методы
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Удаляет псевдоним домена клиента.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Получает псевдоним домена клиента.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
Вставляет псевдоним домена клиента.
list GET /admin/directory/v1/customer/{customer}/domainaliases
Отображает список доменных псевдонимов клиента.

REST-ресурс: домены

Методы
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
Удаляет домен клиента.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
Получает доменное имя клиента.
insert POST /admin/directory/v1/customer/{customer}/domains
Вставляет домен клиента.
list GET /admin/directory/v1/customer/{customer}/domains
Отображает список доменов клиента.

REST-ресурс: группы

Методы
delete DELETE /admin/directory/v1/groups/{groupKey}
Удаляет группу.
get GET /admin/directory/v1/groups/{groupKey}
Получает свойства группы.
insert POST /admin/directory/v1/groups
Создает группу.
list GET /admin/directory/v1/groups
Получает все группы домена или пользователя по заданному userKey (с постраничной навигацией).
patch PATCH /admin/directory/v1/groups/{groupKey}
Обновляет свойства группы.
update PUT /admin/directory/v1/groups/{groupKey}
Обновляет свойства группы.

REST-ресурс: groups.aliases

Методы
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
Удаляет псевдоним.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
Добавляет псевдоним для группы.
list GET /admin/directory/v1/groups/{groupKey}/aliases
Выводит список всех псевдонимов для группы.

REST-ресурс: участники

Методы
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Удаляет участника из группы.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Получает свойства участника группы.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
Проверяет, является ли данный пользователь членом группы.
insert POST /admin/directory/v1/groups/{groupKey}/members
Добавляет пользователя в указанную группу.
list GET /admin/directory/v1/groups/{groupKey}/members
Получает постраничный список всех участников группы.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Обновляет свойства членства пользователя в указанной группе.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Обновляет членство пользователя в указанной группе.

REST-ресурс: мобильные устройства

Методы
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
Выполняет действие, затрагивающее мобильное устройство.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Удаляет мобильное устройство.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Получает свойства мобильного устройства.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
Получает постраничный список всех мобильных устройств, принадлежащих пользователю для данной учетной записи.

REST-ресурс: orgunits

Методы
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Удаляет организационное подразделение.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Извлекает организационную единицу.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
Добавляет организационное подразделение.
list GET /admin/directory/v1/customer/{customerId}/orgunits
Получает список всех организационных подразделений для учетной записи.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Обновляет данные организационного подразделения.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Обновляет данные организационного подразделения.

REST-ресурс: привилегии

Методы
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
Получает постраничный список всех привилегий для клиента.

REST-ресурс: resources.buildings

Методы
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Удаляет здание.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Извлекает здание.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
Вставляет здание.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
Получает список зданий для учетной записи.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Залатывает здание.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Обновляет здание.

REST-ресурс: resources.calendars

Методы
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Удаляет ресурс календаря.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Получает ресурс календаря.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
Вставляет ресурс календаря.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
Получает список ресурсов календаря для учетной записи.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Вносит изменения в ресурс календаря.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Обновляет календарный ресурс.

REST-ресурс: resources.features

Методы
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Удаляет функцию.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Извлекает объект.
insert POST /admin/directory/v1/customer/{customer}/resources/features
Вставляет функцию.
list GET /admin/directory/v1/customer/{customer}/resources/features
Получает список функций для учетной записи.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Вносит изменения в функционал.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
Переименовывает функцию.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Обновляет функцию.

Ресурс REST: назначение ролей

Методы
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Удаляет назначение роли.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Получает информацию о назначении роли.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
Создает назначение роли.
list GET /admin/directory/v1/customer/{customer}/roleassignments
Получает постраничный список всех назначений ролей.

REST-ресурс: роли

Методы
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
Удаляет роль.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
Извлекает роль.
insert POST /admin/directory/v1/customer/{customer}/roles
Создает роль.
list GET /admin/directory/v1/customer/{customer}/roles
Получает постраничный список всех ролей в домене.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
Вставляет патчи в роль.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
Обновляет роль.

REST-ресурс: схемы

Методы
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Удаляет схему.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Получает схему.
insert POST /admin/directory/v1/customer/{customerId}/schemas
Создаёт схему.
list GET /admin/directory/v1/customer/{customerId}/schemas
Получает все схемы для клиента.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Вносит изменения в схему.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Обновляет схему.

REST-ресурс: токены

Методы
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
Удаляет все токены доступа, выданные пользователем для приложения.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
Получает информацию о токене доступа, выданном пользователем.
list GET /admin/directory/v1/users/{userKey}/tokens
Возвращает набор токенов, выданных указанным пользователем сторонним приложениям.

REST-ресурс: двухэтапная проверка

Методы
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
Отключает двухфакторную аутентификацию для пользователя.

REST-ресурс: пользователи

Методы
delete DELETE /admin/directory/v1/users/{userKey}
Удаляет пользователя.
get GET /admin/directory/v1/users/{userKey}
Получает информацию о пользователе.
insert POST /admin/directory/v1/users
Создает пользователя.
list GET /admin/directory/v1/users
Получает постраничный список либо удаленных пользователей, либо всех пользователей в домене.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
Предоставляет пользователю права суперадминистратора.
patch PATCH /admin/directory/v1/users/{userKey}
Обновляет данные пользователя, используя семантику патчей.
signOut POST /admin/directory/v1/users/{userKey}/signOut
Выводит пользователя из всех веб-сессий и сессий на устройстве и сбрасывает его файлы cookie для входа в систему.
undelete POST /admin/directory/v1/users/{userKey}/undelete
Восстанавливает удаленного пользователя.
update PUT /admin/directory/v1/users/{userKey}
Обновляет данные пользователя.
watch POST /admin/directory/v1/users/watch
Отслеживает изменения в списке пользователей.

REST-ресурс: users.aliases

Методы
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
Удаляет псевдоним.
insert POST /admin/directory/v1/users/{userKey}/aliases
Добавляет псевдоним.
list GET /admin/directory/v1/users/{userKey}/aliases
Выводит список всех псевдонимов пользователя.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
Отслеживает изменения в списке пользователей.

REST-ресурс: users.photos

Методы
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
Удаляет фотографию пользователя.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
Получает фотографию пользователя.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
Добавляет фотографию для пользователя.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
Добавляет фотографию для пользователя.

REST-ресурс: verificationCodes

Методы
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
Генерирует новые коды подтверждения резервного копирования для пользователя.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
Аннулирует текущие коды подтверждения резервной копии для пользователя.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
Возвращает текущий набор действительных кодов подтверждения резервной копии для указанного пользователя.