Admin SDK: Directory API

借助 Admin SDK Directory API，企业网域的管理员可以查看和管理其组织的用户、群组、设备和相关资源。Cloud Identity API 提供了其他一些用于管理部分相同资源的方法。

服务：admin.googleapis.com

如要调用此服务，我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务，则在发出 API 请求时应使用以下信息。

发现文档

发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档：

服务端点

服务端点是指定 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}
检索 ChromeOS 设备的属性。
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
检索账号中 ChromeOS 设备的分页列表。
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
将多个 ChromeOS 设备移至或插入组织部门。
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 资源：customers

方法
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 资源：domains

方法
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 资源：groups

方法
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 资源：members

方法
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
retrieving a paginated list of a group's all members
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
更新指定群组中用户的成员资格属性。
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
更新用户在指定群组中的成员资格。

REST 资源：mobiledevices

方法
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 资源：privileges

方法
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
检索所有 roleAssignment 的分页列表。

REST 资源：roles

方法
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 资源：schemas

方法
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 资源：tokens

方法
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 资源：users

方法
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
返回指定用户当前的一组有效备用验证码。