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 的值会强制转换为 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 文档