1. 接口描述
接口请求域名： eiam.tencentcloudapi.com 。
通过用户名或用户 id 冻结用户
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
本文档展示的是V1签名的参数说明，腾讯云建议您使用安全系数更高的V3签名算法，使用签名方法 v3 时，公共参数需要统一放到 HTTP Header 请求头部中，详情。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyUserInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2021-04-20。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| UserName | 否 | String | 用户名，长度限制：32个字符。 Username 和 UserId 需选择一个作为搜索条件；如两个条件同时使用则默认使用Username作为搜索条件。 |
| DisplayName | 否 | String | 昵称，长度限制：64个字符。 默认与用户名相同。 |
| Description | 否 | String | 用户备注，长度限制：512个字符。 |
| UserGroupIds.N | 否 | Array of String | 用户所属用户组ID列表。 |
| UserId | 否 | String | 用户 id。 Username 和 UserId 需选择一个作为搜索条件；如两个条件同时使用则默认使用Username作为搜索条件。 |
| Phone | 否 | String | 用户手机号。 |
| ExpirationTime | 否 | String | 用户过期时间，遵循 ISO 8601 标准。 |
| Password | 否 | String | 用户密码， 需要符合密码策略的配置。 |
| 否 | String | 用户邮箱。 | |
| PwdNeedReset | 否 | Boolean | 密码是否需要重置，为空默认为false不需要重置密码。 |
| OrgNodeId | 否 | String | 用户所属的主组织机构唯一ID。如果为空，默认为在根节点下创建用户。 |
| SecondaryOrgNodeIdList.N | 否 | Array of String | 用户所属的次要组织机构ID列表。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: eiam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyUserInfo
<公共请求参数>
{
"DisplayName": "修改用户",
"UserId": "3945dcb0-e433-4fd0-a69b-b5074abe3cbd"
}输出示例
{
"Response": {
"RequestId": "2b2d3828-82ec-483c-b8cc-9e5f2da05905"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DescribeOrgNodeError | 读取机构节点信息失败。 |
| FailedOperation.DescribeOrgNodeRootError | 读取根机构节点信息失败。 |
| FailedOperation.GroupIdNotFound | 用户组ID未找到。 |
| FailedOperation.MainOrgNodeNotExist | 主组织机构不存在。 |
| FailedOperation.NewPasswordMustNotBlank | 新密码必须不能为空。 |
| FailedOperation.OperationError | 操作失败。 |
| FailedOperation.OrgNodeNotExist | 机构节点不存在。 |
| FailedOperation.OrgNodeSettingError | 组织机构设置失败，组织机构不可同时被选择为用户所属的主组织和次要机构。 |
| FailedOperation.PersonNotFound | 身份主体未找到。 |
| FailedOperation.SecondaryOrgNodeDuplicates | 次要机构元素重复。 |
| FailedOperation.UpdateLDAPUserOrgExceedsRange | 不能变更LDAP导入的用户到目录外的组织机构下。 |
| FailedOperation.UpdateLDAPUserOrgNotInSameCrop | 不能变更LDAP导入的用户到其他目录的企业机构下。 |
| FailedOperation.UpdateUserExceedsRange | 不能变更自建用户到有同步操作类型的组织机构下。 |
| FailedOperation.UpdateWeComUserOrgExceedsRange | 不能变更企业微信用户到企业外的组织机构。 |
| FailedOperation.UpdateWeComUserOrgNotInSameCrop | 不能变更企业微信用户到非相同的企业机构下。 |
| FailedOperation.UserEmailExisted | 用户邮箱已存在。 |
| FailedOperation.UserPhoneAlreadyExists | 用户手机已存在。 |
| FailedOperation.UserPhoneIsEmpty | 用户手机不能为空。 |
| InvalidParameter.AttributeValueValidError | 属性校验失败。 |
| InvalidParameter.UserExpirationTimeIllegal | 设定的用户过期时间不合法。 |
| InvalidParameter.UserIDIsNull | 用户ID参数为空。 |
| InvalidParameter.UserNameIsNull | 用户名参数为空。 |
| InvalidParameterValue.ParameterIllegal | 参数不合法。 |
| LimitExceeded.ParameterLengthLimitExceeded | 输入参数超出长度限制。 |
| LimitExceeded.SecondaryNodeCountLimitExceeded | 用户的次要机构超出数量上限。 |