修改用户信息
最近更新时间: 2026-09-17 00:00:19
1. 接口描述
接口请求域名： bhsaas.api3.fincloud.tencent.cn。
修改用户信息
默认接口请求频率限制：20次/秒。
接口更新时间：2023-09-05 03:35:17。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyUser |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-10-18 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| Id | 是 | 否 | Uint64 | 用户ID 示例值： 1 |
| RealName | 是 | 否 | String | 用户姓名，最大长度20个字符，不能包含空格 示例值： zhangsan |
| Phone | 否 | 否 | String | 大陆手机号直接填写，如果是其他国家、地区号码,按照"国家地区代码 |
| 否 | 否 | String | 电子邮件 示例值： 198***@email.com |
|
| ValidateFrom | 否 | 否 | Datetime_iso | 用户生效时间，如:"2021-09-22T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值： 2021-01-01T08:00:01+08:00 |
| ValidateTo | 否 | 否 | Datetime_iso | 用户失效时间，如:"2021-09-23T00:00:00+00:00" 生效、失效时间不填则用户长期有效 示例值： 2021-01-01T08:00:01+08:00 |
| GroupIdSet | 否 | 否 | Array of Uint64 | 所属用户组ID集合 示例值： [1,2] |
| AuthType | 否 | 否 | Uint64 | 认证方式，0 - 本地，1 - LDAP，2 - OAuth 不传则默认为0 示例值： 0 |
| ValidateTime | 否 | 否 | String | 访问时间段限制， 由0、1组成的字符串，长度168(7 × 24)，代表该用户在一周中允许访问的时间段。字符串中第N个字符代表在一周中的第N个小时， 0 - 代表不允许访问，1 - 代表允许访问 示例值： 0000000000000000000000000000000000000000000000000000000000000000 |
| DepartmentId | 否 | 否 | String | 用户所属部门的ID，如1.2.3 示例值： 1.2.3 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ResourceId | 无效的资源ID，用于资源不存在或已过期。 |
| UnauthorizedOperation.NoPermission | 无操作权限。 |
| UnsupportedOperation | 操作不支持。 |
| ResourceInUse | 资源被占用。 |
| UnauthorizedOperation | 未授权操作。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter | 参数错误。 |
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| LimitExceeded | 超过配额限制。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceNotFound | 资源不存在。 |
| OperationDenied | 操作被拒绝。 |
| ResourcesSoldOut | 资源售罄。 |
| InvalidParameterValue | 参数取值错误。 |
| FailedOperation | 操作失败。 |
| UnknownParameter | 未知参数错误。 |
| FailedOperation.DuplicateData | 重复数据。 |
| FailedOperation.DataNotFound | 目标数据不存在。 |
5. 示例
示例1 修改用户信息
修改用户信息
输入示例
POST / HTTP/1.1
Host: dasb.platformcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyUser
<公共请求参数>
{
"Id": 1,
"ValidateTo": "2020-09-22T00:00:00+00:00",
"RealName": "test",
"GroupIdSet": [
1,
2,
3
],
"Phone": "4394567891",
"ValidateFrom": "2020-09-22T00:00:00+00:00",
"Email": "test@test.com"
}
输出示例
{
"Response": {
"RequestId": "123"
}
}