创建用户
最近更新时间: 2026-10-12 00:11:05
1. 接口描述
接口请求域名: cic.api3.fincloud.tencent.com。
创建用户
默认接口请求频率限制:20次/秒。
接口更新时间:2024-12-11 12:17:58。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateUser |
| Version | 是 | 否 | String | 公共参数,本接口取值:2021-03-31 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| FirstName | 否 | 是 | String | 用户的姓。 长度:最大 64 个字符。 示例值: Alice |
| Description | 否 | 是 | String | 用户的描述。 长度:最大 1024 个字符。 示例值: description |
| UserStatus | 否 | 是 | String | 用户的状态。取值: Enabled(默认值):启用。 Disabled:禁用。 示例值: Enabled |
| UserType | 否 | 是 | String | 用户类型 Manual:手动创建,Synchronized:外部导入 示例值: Manual |
| ZoneId | 是 | 是 | String | 空间 ID。 示例值: z-2d8shd8*** |
| LastName | 否 | 是 | String | 用户的名。 长度:最大 64 个字符。 示例值: Alice |
| DisplayName | 否 | 是 | String | 用户的显示名称。 长度:最大 256 个字符。 示例值: Alice |
| 否 | 是 | String | 用户的电子邮箱。目录内必须唯一。 长度:最大 128 个字符。 示例值: Alice@example.com |
|
| UserName | 是 | 是 | String | 用户名称。空间内必须唯一。不支持修改。 格式:包含数字、英文字母和特殊符号+ = , . @ - _ 。 长度:最大 64 个字符 示例值: Alice |
3. 输出参数
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.IdentityCenterNotOpen | |
| FailedOperation.ZoneIdNotExist | |
| InvalidParameter.UsernameFormatError | |
| InvalidParameter.UsernameAlreadyExists | |
| InvalidParameter.EmailAlreadyExists | |
| FailedOperation.UserOverUpperLimit | |
| LimitExceeded.CreateUserLimitExceeded |
5. 示例
示例1 创建用户
输入示例
{
"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",
"Password": "d893nd8!@HK&",
"CreateTime": "2024-02-02 12:12:12",
"UpdateTime": "2024-02-02 12:12:12"
},
"RequestId": "e297543a-80de-4039-83c8-9d35d4545"
}
}