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

這是必要旗標，客戶在 Cloud Identity 中的專屬 ID。客戶 ID 是英數字串，開頭為字母 C，例如 C01234abc。如要查看客戶 ID，請參閱「查看客戶 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

詳情請參閱授權指南。