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 資源：asp

方法
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
將多個 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
擷取群組內所有成員的分頁清單。
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 資源：權限

方法
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 資源：結構定義

方法
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}
使用 Patch 語意更新使用者。
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
傳回指定使用者目前的有效備用驗證碼組合。