本文件包含 Directory API 專屬授權和驗證資訊。閱讀本文件前,請務必參閱「瞭解驗證和授權」一文,瞭解 Google Workspace 的一般驗證和授權資訊。
設定授權所需的 OAuth 2.0
設定 OAuth 同意畫面並選擇範圍,定義要向使用者顯示的資訊及應用程式審查者,並註冊應用程式以供日後發布。
Directory API 範圍
如要定義授予應用程式的存取權層級,您必須識別並宣告授權範圍。授權範圍是 OAuth 2.0 URI 字串,包含 Google Workspace 應用程式名稱、應用程式存取的資料類型,以及存取層級。「範圍」是應用程式要求處理 Google Workspace 資料的要求,包括使用者的 Google 帳戶資料。
應用程式安裝完畢後,系統會要求使用者驗證應用程式使用的範圍。一般而言,您應選擇盡可能縮小的範圍,並避免要求應用程式不需要的範圍。使用者能夠更順利地授予描述過明確、有限範圍的存取權。
Directory API 支援下列範圍:
裝置範圍 | 意義 |
---|---|
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 |
範圍僅用於擷取行事曆資源。 |