List Users

GET /api/v1/users

UserService · UserService_ListUsers

基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义；本站不会向真实服务执行示例。

访问权限

需要实例管理员；普通已认证账号不能执行此操作。

管理员列表行为

支持分页。唯一支持的筛选形式是 username 与非空字符串相等，例如 username == "alice"。声明的 showDeleted 不会提供独立的回收站视图。结果按接口固定顺序包含已存储用户。

请求

ListUsers returns a list of users.

GET/api/v1/users

参数

名称 / 位置	类型 / 是否必需	描述
`pageSize` query	integer (int32) OpenAPI 未标记为必需	Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
`pageToken` query	string OpenAPI 未标记为必需	Optional. A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page.
`filter` query	string OpenAPI 未标记为必需	Optional. Filter to apply to the list results. Example: "username == 'steven'" Supported operators: == Supported fields: username
`showDeleted` query	boolean OpenAPI 未标记为必需	Optional. If true, show deleted users in the response.

请求体

未声明请求体。

响应

200 · OK

application/json · ListUsersResponse

default · Default error response

application/json · Status

完整操作定义

下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。

展开 JSON 定义

{
  "tags": [
    "UserService"
  ],
  "description": "ListUsers returns a list of users.",
  "operationId": "UserService_ListUsers",
  "parameters": [
    {
      "name": "pageSize",
      "in": "query",
      "description": "Optional. The maximum number of users to return.\n The service may return fewer than this value.\n If unspecified, at most 50 users will be returned.\n The maximum value is 1000; values above 1000 will be coerced to 1000.",
      "schema": {
        "type": "integer",
        "format": "int32"
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "Optional. A page token, received from a previous `ListUsers` call.\n Provide this to retrieve the subsequent page.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "Optional. Filter to apply to the list results.\n Example: \"username == 'steven'\"\n Supported operators: ==\n Supported fields: username",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "showDeleted",
      "in": "query",
      "description": "Optional. If true, show deleted users in the response.",
      "schema": {
        "type": "boolean"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListUsersResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}