1. 接口描述
接口请求域名： organization.tencentcloudapi.com 。
创建用户
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateUser。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-31。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 空间 ID。 示例值：z-00fc2p61**** |
| UserName | 是 | String | 用户名称。空间内必须唯一。不支持修改。 格式：包含数字、英文字母和特殊符号+ = , . @ - _ 。 长度：最大 64 个字符 示例值：Alice |
| FirstName | 否 | String | 用户的姓。 长度：最大 64 个字符。 示例值：Alice |
| LastName | 否 | String | 用户的名。 长度：最大 64 个字符。 示例值：Alice |
| DisplayName | 否 | String | 用户的显示名称。 长度：最大 256 个字符。 示例值：Alice |
| Description | 否 | String | 用户的描述。 长度：最大 1024 个字符。 示例值：This is a user. |
| 否 | String | 用户的电子邮箱。目录内必须唯一。 长度：最大 128 个字符。 示例值：Alice@example.com |
|
| UserStatus | 否 | String | 用户的状态。取值： Enabled（默认值）：启用。 Disabled：禁用。 示例值：Enabled |
| UserType | 否 | String | 用户类型 Manual：手动创建，Synchronized：外部导入 示例值：Manual |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UserInfo | UserInfo | 用户详情 示例值：{"ZoneId": "z-3fee3r3r3"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建用户
创建用户
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUser
<公共请求参数>
{
"ZoneId": "z-33w3je****",
"UserName": "Alice",
"FirstName": "Alice",
"LastName": "Alice",
"DisplayName": "Alice",
"Description": "this is user",
"Email": "Alice@example.com",
"UserStatus": "Enabled"
}输出示例
{
"Response": {
"UserInfo": {
"UserName": "Alice",
"FirstName": "Alice",
"LastName": "Alice",
"DisplayName": "Alice",
"Description": "this is user",
"Email": "Alice@example.com",
"UserStatus": "Enabled",
"UserType": "Manual",
"UserId": "u-2342ds2s",
"CreateTime": "2024-02-02 12:12:12",
"UpdateTime": "2024-02-02 12:12:12"
},
"RequestId": "e297543a-80de-4039-83c8-9d35d4545"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.IdentityCenterNotOpen | CIC服务没有开通 |
| FailedOperation.UserOverUpperLimit | 用户创建超过上限 |
| FailedOperation.ZoneIdNotExist | CIC服务的用户zoneId不存在 |
| InvalidParameter.EmailAlreadyExists | 邮箱已经存在 |
| InvalidParameter.UsernameAlreadyExists | 用户名已经存在 |
| InvalidParameter.UsernameFormatError | 用户名格式错误 |
| LimitExceeded.CreateUserLimitExceeded | 请求创建用户超出限制。 |
