支持部分字段更新当前用户信息,并返回完整用户信息。
接口说明
请求说明
该 API 允许调用者更新指定用户的部分或全部可选字段,未提供的字段将保持原有值。
支持通过
tenantId参数指定租户 ID;若省略,则默认使用调用方的默认租户。更新成功后,响应体中会包含完整的用户信息对象。
此接口要求认证,支持 AK、BearerToken 和 APP 三种安全方案。
接口消费类型为 JSON 格式,且仅在 HTTPS 协议下可用。
特别注意:
profileRoleInfo字段仅当用户角色设置为 Others 时有效,用于描述用户的具体角色信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
winnexo:UpdateUserInfo |
none |
*全部资源
|
无 | 无 |
请求语法
POST /openapi/updateUserInfo HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
生效租户 ID。 |
10000 |
| name |
string |
否 |
姓名。 |
示例名称.pdf |
| avatar |
string |
否 |
头像 URL。 |
https://example.com/avatar.png |
| languagePreference |
string |
否 |
语言偏好: zh-CN, en-US。 |
string_value |
| profileRoleInfo |
string |
否 |
用户角色描述(当 profileRole 为 Others 时使用),最多 100 字符。 |
string_value |
| offering |
string |
否 |
用户服务描述,最多 1000 字符。 |
string_value |
| selfIntroduction |
string |
否 |
用户自我介绍,最多 1000 字符。 |
string_value |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
更新当前用户信息。 |
||
| code |
string |
错误码。 |
200 |
| message |
string |
状态码描述。 |
The current zone list is illegal. |
| requestId |
string |
请求 ID。 |
019FF406-1B10-0065-A97D-2D1920C2A03D |
| user |
object |
用户信息。 |
|
| avatar |
string |
用户头像 URL |
https://example.com/avatar.png |
| isAdmin |
boolean |
是否为超级管理员 |
true |
| isSystemTenant |
boolean |
当前登录租户是否为系统租户 |
true |
| languagePreference |
string |
用户语言偏好 |
string_value |
| name |
string |
用户名称。 |
示例名称.pdf |
| offering |
string |
用户服务描述 |
string_value |
| parsedOffering |
string |
用户服务解析结果(JSON 格式) |
string_value |
| profileRole |
string |
用户角色 |
string_value |
| profileRoleInfo |
string |
用户角色描述 |
string_value |
| selfIntroduction |
string |
用户自我介绍 |
string_value |
| tenantId |
integer |
当前租户 ID |
10000 |
| tenantList |
array<object> |
用户所属租户列表 |
|
|
object |
租户信息。 |
||
| tenantId |
integer |
租户 ID |
10000 |
| tenantName |
string |
租户名称 |
string_value |
| tenantName |
string |
当前租户名称 |
string_value |
| userCode |
string |
用户代码 |
string_value |
| userId |
integer |
用户 ID |
1 |
示例
正常返回示例
JSON格式
{
"code": "200",
"message": "The current zone list is illegal.",
"requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
"user": {
"avatar": "https://example.com/avatar.png",
"isAdmin": true,
"isSystemTenant": true,
"languagePreference": "string_value",
"name": "示例名称.pdf",
"offering": "string_value",
"parsedOffering": "string_value",
"profileRole": "string_value",
"profileRoleInfo": "string_value",
"selfIntroduction": "string_value",
"tenantId": 10000,
"tenantList": [
{
"tenantId": 10000,
"tenantName": "string_value"
}
],
"tenantName": "string_value",
"userCode": "string_value",
"userId": 1
}
}