接口请求域名: organization.intl.tencentcloudapi.com 。
修改用户信息
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateUser。 |
| Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ZoneId | 是 | String | 空间 ID。 |
| UserId | 是 | String | 用户 ID。 |
| NewFirstName | 否 | String | 用户的名。 |
| NewLastName | 否 | String | 用户的姓。 |
| NewDisplayName | 否 | String | 用户的显示名称。 |
| NewDescription | 否 | String | 用户的描述。 |
| NewEmail | 否 | String | 用户的电子邮箱。 |
| NeedResetPassword | 否 | Boolean | 是否需要重置密码 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UserInfo | UserInfo | 用户信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
修改用户信息
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateUser
<公共请求参数>
{
"ZoneId": "z-343nh23kn",
"UserId": "u-3324sfdds",
"NewFirstName": "john",
"NewLastName": "smith",
"NewDisplayName": "john",
"NewDescription": "this is user.",
"NewEmail": "test@example.com"
}
{
"Response": {
"UserInfo": {
"UserName": "user1",
"FirstName": "john",
"LastName": "smith",
"DisplayName": "john",
"Description": "this is user",
"Email": "test@example.com",
"UserStatus": "Enabled",
"UserType": "Manual",
"UserId": "u-33sjadjsk",
"CreateTime": "2024-01-01 12:12:12",
"UpdateTime": "2024-01-01 12:12:12"
},
"RequestId": "e297543a-80de-4039-83c8-34545s45"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.IdentityCenterNotOpen | CIC服务没有开通 |
| FailedOperation.ManualUserNotUpdate | 手动用户不允许更新 |
| FailedOperation.SynchronizedUserNotUpdate | 同步的用户不允许修改 |
| FailedOperation.ZoneIdNotExist | CIC服务的用户zoneId不存在 |
| InvalidParameter.EmailAlreadyExists | 邮箱已经存在 |
| InvalidParameter.UserTypeError | 用户类型错误。 |
| ResourceNotFound.UserNotExist | 用户不存在。 |
文档反馈