UserService · UserService_ListUserSettings
基于协议生成的参考。授权与实例策略仍然生效。结构描述继承自 MIT 许可的应用接口定义;本站不会向真实服务执行示例。
访问权限
仅限所有者:路径中的用户必须是已认证调用者;实例管理员身份不允许在此代替其他账号操作。
小集合不分页
当前实现返回整个允许集合,nextPageToken 为空。协议中的 pageSize/pageToken 不切分此集合。PAT 列表仅提供元数据,不返回之前创建的令牌值。
可用设置键有限
暴露的设置键为 GENERAL、TAGS 与 WEBHOOKS。账号令牌与会话存储不作为设置暴露。WEBHOOKS 在此只读,应通过独立的 Webhook 操作管理。缺失 GENERAL 设置时返回默认投影。
请求
ListUserSettings returns a list of user settings.
GET
/api/v1/users/{user}/settings参数
| 名称 / 位置 | 类型 / 是否必需 | 描述 |
|---|---|---|
userpath | string 必需 | The user id. |
pageSizequery | integer (int32) OpenAPI 未标记为必需 | Optional. The maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 50 settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
pageTokenquery | string OpenAPI 未标记为必需 | Optional. A page token, received from a previous `ListUserSettings` call. Provide this to retrieve the subsequent page. |
请求体
未声明请求体。
响应
200 · OK
application/json · ListUserSettingsResponse
default · Default error response
application/json · Status
完整操作定义
下方保留全部已声明约束、媒体类型和响应细节。结构引用链接到完整定义。
展开 JSON 定义
{
"tags": [
"UserService"
],
"description": "ListUserSettings returns a list of user settings.",
"operationId": "UserService_ListUserSettings",
"parameters": [
{
"name": "user",
"in": "path",
"description": "The user id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Optional. The maximum number of settings to return.\n The service may return fewer than this value.\n If unspecified, at most 50 settings 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 `ListUserSettings` call.\n Provide this to retrieve the subsequent page.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListUserSettingsResponse"
}
}
}
},
"default": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
}
}
}
}
}
}