Method: users.settings.cse.identities.list

列出已驗證使用者的用戶端加密身分。

如果管理員要為機構中的使用者管理身分和金鑰組，則必須使用服務帳戶授權要求，該帳戶必須具備全網域委派授權，才能以 https://www.googleapis.com/auth/gmail.settings.basic 範圍模擬使用者。

如果使用者自行管理身分和金鑰組，則必須開啟並設定硬體金鑰加密功能，才能提出要求。

HTTP 要求

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
userId

string

要求者的主要電子郵件地址。如要指出已驗證的使用者，可以使用特殊值 me。

查詢參數

參數
pageToken

string

分頁符記，指出要傳回哪個身分識別頁面。如果未提供權杖，API 會傳回第一頁結果。
pageSize

integer

要傳回的身分數量。如未提供，頁面大小預設為 20 個項目。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
欄位
cseIdentities[]

object (CseIdentity)

使用者設定的 CSE 身分清單，一頁顯示一個身分。
nextPageToken

string

分頁符記，傳遞至後續的 identities.list 呼叫，即可擷取下一頁身分。如果未傳回這個值或傳回空字串，表示沒有其他頁面。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

詳情請參閱OAuth 2.0 Overview。