Method: accounts.list

列出经过身份验证的用户的所有帐号。这包括用户拥有的所有帐号,以及用户拥有管理权限的所有帐号。

HTTP 请求

GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts

网址采用 gRPC 转码语法。

查询参数

参数
parentAccount

string

可选。要获取可直接访问的帐号列表的帐号的资源名称。这仅适用于组织和用户群组。如果为空,系统将针对经过身份验证的用户返回 accounts.listaccounts/{account_id}.

pageSize

integer

可选。每页可提取的帐号数量。默认值和最大值为 20。

pageToken

string

可选。如果指定,则检索下一页帐号。调用 accounts.list 返回的结果数超过所请求的页面大小可以容纳的数量时,系统会返回 pageToken

filter

string

可选。用于限制要返回的帐号的过滤条件。响应仅包含与过滤条件匹配的条目。如果 filter 为空,则系统不会应用任何限制条件,并检索所请求帐号的所有帐号(分页)。

例如,使用过滤条件 type=USER_GROUP 的请求将仅返回用户群组。

type 字段是唯一受支持的过滤条件。

请求正文

请求正文必须为空。

响应正文

Accounts.ListAccounts 的响应消息。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
字段
accounts[]

object (Account)

用户有访问权限的一组帐号。执行查询的用户的个人帐号将始终是结果的第一个项目,除非帐号被滤除。

nextPageToken

string

如果帐号数量超过所请求的页面大小,系统会使用令牌填充此字段,以在后续调用 accounts.list 时获取下一页帐号。如果没有更多帐号,此字段不会出现在响应中。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/business.manage

有关详情,请参阅 OAuth 2.0 概览