Method: projects.locations.userStores.userLicenses.list

列出使用者授權。

HTTP 要求

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/userStores/*}/userLicenses

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

路徑參數

參數
parent

string

這是必要旗標，父項 [UserStore][] 資源名稱，格式為 projects/{project}/locations/{location}/userStores/{userStoreId}。

查詢參數

參數
pageSize

integer

(選用步驟) 要求的頁面大小。伺服器傳回的項目數量可能會少於要求數量。如未指定，則預設值為 10。許可的最大值為 50；超出的數值將一律指定為 50。

如果這個欄位為負數，系統會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

(選用步驟) 屬於接收自前一個 userLicenses.list 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 userLicenses.list 的所有其他參數須與提供網頁權杖的呼叫相符。
filter

string

(選用步驟) 清單要求的篩選條件。

支援的欄位：

  • licenseAssignmentState

範例：

  • licenseAssignmentState = ASSIGNED，列出指派的使用者授權。
  • licenseAssignmentState = NO_LICENSE，列出未取得授權的使用者。
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN，列出嘗試登入但未獲指派授權的使用者。
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN，篩除嘗試登入但未獲指派授權的使用者。

要求主體

要求主體必須為空白。

回應主體

UserLicenseService.ListUserLicenses 的回應訊息。

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

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

object (UserLicense)

客戶的所有 UserLicense。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。

授權範圍

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳情請參閱Authentication Overview。

IAM 權限

需要 parent 資源的下列 IAM 權限：

  • discoveryengine.userStores.listUserLicenses

詳情請參閱 IAM 說明文件。