1. 接口描述
接口请求域名: ciam.tencentcloudapi.com 。
更新用户组
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateUserGroup。 | 
| Version | 是 | String | 公共参数,本接口取值:2022-03-31。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| UserGroupId | 是 | String | 用户组ID 示例值:6cd22e51****f6f7cb81  | 
| DisplayName | 是 | String | 用户组名称 示例值:用户组1  | 
| UserStoreId | 是 | String | 用户目录ID 示例值:2c3aca3b****a7efe88e  | 
| Description | 否 | String | 用户组描述 示例值:包含了一组用户  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 更新用户组
输入示例
POST / HTTP/1.1
Host: ciam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateUserGroup
<公共请求参数>
{
    "UserGroupId": "6cd22e51****************f6f7cb81",
    "DisplayName": "用户组1",
    "Description": "包含了一组用户",
    "UserStoreId": "2c3aca3b****************a7efe88e"
}
输出示例
{
    "Response": {
        "RequestId": "e2e9e8aa********************9ab34c6e"
    }
}
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: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
 - Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
 
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| AuthFailure | CAM签名/鉴权错误。 | 
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 | 
| FailedOperation | 操作失败。 | 
| FailedOperation.AuthSourceNameAlreadyExists | 认证源名称已存在。 | 
| FailedOperation.AuthSourceNotFound | 认证源不存在。 | 
| FailedOperation.InvalidTenant | 无效租户。 | 
| FailedOperation.InvalidUserStore | 无效用户池。 | 
| FailedOperation.QuotaLimitExceeded | 配额超限,如有需求请联系客服人员。 | 
| FailedOperation.UserGroupNameAlreadyExists | 用户组名称已存在。 | 
| FailedOperation.UserGroupNotFound | 用户组不存在。 | 
| FailedOperation.UserPropertyCodeAlreadyExists | 属性标识已存在。 | 
| FailedOperation.UserPropertyNotFound | 用户属性不存在。 | 
| FailedOperation.UserStoreDomainAlreadyExists | 已存在相同域名。 | 
| InternalError | 内部错误。 | 
| InternalError.JudgeUserExistException | 判断存在用户内部请求错误,请稍后重试。 | 
| InternalError.UnknownError | 未知错误。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameter.ParameterIllegal | 请求参数不合法。 | 
| InvalidParameterValue | 参数取值错误。 | 
| LimitExceeded | 超过配额限制。 | 
| MissingParameter | 缺少参数错误。 | 
| OperationDenied | 操作被拒绝。 | 
| RequestLimitExceeded | 请求的次数超过了频率限制。 | 
| RequestLimitExceeded.FrequentRequest | 请求过于频繁,请稍后再试。 | 
| RequestLimitExceeded.RepeatRequest | 请求重复,请稍后再试。 | 
| ResourceInUse | 资源被占用。 | 
| ResourceInsufficient | 资源不足。 | 
| ResourceNotFound | 资源不存在。 | 
| ResourceUnavailable | 资源不可用。 | 
| ResourcesSoldOut | 资源售罄。 | 
| UnauthorizedOperation | 未授权操作。 | 
| UnauthorizedOperation.TenantNotActivated | 服务未开通。 | 
| UnknownParameter | 未知参数错误。 | 
| UnsupportedOperation | 操作不支持。 | 
| UnsupportedOperation.EnabledAuthSourceCanNotBeDeleted | 认证源已启用,不允许删除。 | 
| UnsupportedOperation.EnabledAuthSourceCanNotBeUpdated | 认证源已启用,不允许更新。 | 
| UnsupportedOperation.InternalUserProperty | 内置属性不支持该操作。 | 
| UnsupportedOperation.LinkedAppUserPropertyCanNotBeDeleted | 属性被应用关联,不允许删除。 | 
| UnsupportedOperation.LinkedAuthSourceCanNotBeClosed | 认证源被应用关联,不允许关闭。 | 
| UnsupportedOperation.LinkedAuthSourceCanNotBeDeleted | 认证源被应用关联,不允许删除。 | 
| UnsupportedOperation.LinkedAuthSourceUserPropertyCanNotBeDeleted | 属性被认证源关联,不允许删除。 | 
| UnsupportedOperation.LinkedUserPropertyCanNotBeDeleted | 属性被其它模块关联,不允许删除。 | 
| UnsupportedOperation.PlatformDomainSuffixCanNotBeUsed | 不允许使用平台域名后缀作为自有域名后缀。 | 
| UnsupportedOperation.WhenUserExistUserPropertyCanNotBeDeleted | 用户池下已存在用户,用户属性不允许被删除。 |