Admin SDK: Directory API

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

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

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

Документ открытия

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

Конечная точка службы

Конечная точка службы — это базовый 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.
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: доменалиасы

Методы
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: оргунитс

Методы
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: roleAssignments

Методы
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: twoStepVerification

Методы
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: user.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: user.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: коды проверки

Методы
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
Возвращает текущий набор действительных резервных кодов проверки для указанного пользователя.