Method: customers.v2.Users.list

擷取使用者清單。

  • 要求必須指定篩選條件。如果要求沒有 filter 參數，系統會傳回 tooMany 錯誤。
  • filter 參數僅支援 userName 的等號 (例如 userName eq "user@domain.com")。
  • 不支援子字串比對 (co、sw、ew)、邏輯運算子 (and、or) 和複雜值篩選器。
  • 不支援分頁。

HTTP 要求

GET https://cloudidentityscim.googleapis.com/v1beta1/customers/{customerId}/v2/Users

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

路徑參數

參數
customerId

string

這是必要旗標，客戶 ID。

查詢參數

參數
filter

string

篩選器參數。目前僅支援 userName 的等號。

要求主體

要求主體必須為空白。

回應主體

來自房源使用者的回覆訊息。

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

JSON 表示法 
{
  "schemas": [
    string
  ],
  "resources": [
    {
      object (User)
    }
  ],
  "totalResults": integer
}
欄位
schemas[]

string

傳回資源的結構定義。
resources[]

object (User)

要求的資源清單。
totalResults

integer

結果總數。

授權範圍

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

  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/admin.directory.user

詳情請參閱授權指南。