Directory API:授權要求

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

您的應用程式傳送至 Admin SDK API 的所有要求都必須包含授權權杖。這個憑證也可讓 Google 識別您的應用程式。

關於授權通訊協定

您的應用程式必須使用 OAuth 2.0 對要求進行授權,系統不支援其他授權通訊協定。如果您的應用程式採用使用 Google 帳戶登入功能,系統會為您處理部分授權事項。

使用 OAuth 2.0 對要求進行授權

所有對 Admin SDK API 的要求都必須由已驗證的使用者授權。

OAuth 2.0 授權程序 (或「流程」) 的細節會根據您編寫的應用程式類型而有所不同。下列一般程序適用於所有應用程式類型:

  1. 建立應用程式後,請透過 Google API 控制台註冊應用程式。接著 Google 會向您提供稍後需要的資訊,例如用戶端 ID 和用戶端密碼。
  2. 在 Google API 控制台啟用 Admin SDK API。(如果 API 控制台裡沒有列出該 API,則可略過這個步驟)。
  3. 當應用程式需要存取使用者資料時,會向 Google 要求特定的存取範圍
  4. Google 會向使用者顯示同意畫面,請對方授權您的應用程式要求部分資料。
  5. 如果使用者同意,Google 即會授予短期存取憑證給您的應用程式。
  6. 您的應用程式向使用者要求資料,並且在要求中附上存取憑證。
  7. 如果 Google 判定您的要求與憑證有效,便會傳回您要求的資料。

部分流程包含額外步驟,例如使用「更新憑證」來取得新的存取憑證。如要進一步瞭解各類應用程式的流程,請參閱 Google 的 OAuth 2.0 說明文件

以下是 Admin SDK API 的 OAuth 2.0 範圍資訊:

裝置範圍 意義
https://www.googleapis.com/auth/admin.directory.device.chromeos 可存取所有 Chrome 裝置作業的全域範圍。
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly 僅擷取 Chrome 裝置的範圍。
https://www.googleapis.com/auth/admin.directory.device.mobile 可存取所有行動裝置作業的全域範圍。
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly 僅擷取行動裝置的範圍
https://www.googleapis.com/auth/admin.directory.device.mobile.action 針對在行動裝置上執行動作的工作範圍。
群組、群組別名和群組成員的範圍 意義
https://www.googleapis.com/auth/admin.directory.group.member 可存取所有群組成員角色和資訊作業的範圍。
https://www.googleapis.com/auth/admin.directory.group.member.readonly 僅擷取群組成員角色和資訊的範圍。
https://www.googleapis.com/auth/admin.directory.group 所有群組作業的全域範圍,包括群組別名和成員。
https://www.googleapis.com/auth/admin.directory.group.readonly 僅擷取群組、群組別名和成員資訊的範圍。
機構單位範圍 意義
https://www.googleapis.com/auth/admin.directory.orgunit 所有機構單位作業的存取範圍。
https://www.googleapis.com/auth/admin.directory.orgunit.readonly 僅擷取機構單位的範圍。
使用者和使用者別名的範圍 意義
https://www.googleapis.com/auth/admin.directory.user 可存取所有使用者和使用者別名作業的全域範圍。
https://www.googleapis.com/auth/admin.directory.user.readonly 僅供擷取使用者或使用者別名的範圍。
https://www.googleapis.com/auth/admin.directory.user.alias 可存取所有使用者別名作業的範圍。
https://www.googleapis.com/auth/admin.directory.user.alias.readonly 僅擷取使用者別名的範圍。
使用者安全性功能的範圍 意義
https://www.googleapis.com/auth/admin.directory.user.security 可存取所有應用程式特定密碼、OAuth 權杖和驗證碼作業的範圍。
角色管理的範圍 意義
https://www.googleapis.com/auth/admin.directory.rolemanagement 所有角色管理作業的範圍,包括建立角色和角色指派作業。
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly 取得及列出角色、權限和角色指派作業的範圍。
自訂使用者結構定義的範圍 意義
https://www.googleapis.com/auth/admin.directory.userschema 可存取所有自訂使用者結構定義作業的範圍。
https://www.googleapis.com/auth/admin.directory.userschema.readonly 僅擷取自訂使用者架構的範圍。
客戶範圍 意義
https://www.googleapis.com/auth/admin.directory.customer 可存取所有客戶作業的範圍。
https://www.googleapis.com/auth/admin.directory.customer.readonly 僅供擷取客戶的範圍。
網域範圍 意義
https://www.googleapis.com/auth/admin.directory.domain 可存取所有網域作業的範圍。
https://www.googleapis.com/auth/admin.directory.domain.readonly 僅供擷取網域的範圍。
日曆資源的範圍 意義
https://www.googleapis.com/auth/admin.directory.resource.calendar 可存取所有日曆資源作業的範圍。
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly 範圍僅可用於擷取日曆資源。

如要透過 OAuth 2.0 要求存取權,您的應用程式需要範圍資訊,以及 Google 在您註冊應用程式時提供的資訊 (例如用戶端 ID 和用戶端密碼)。

提示:Google API 用戶端程式庫可以為您處理部分授權程序,且適用於多種程式設計語言;詳情請參閱程式庫和範例頁面