有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: eiam.tencentcloudapi.com 。

新建一个用户

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateUser。
Version String 公共参数,本接口取值:2021-04-20。
Region String 公共参数,本接口不需要传递此参数。
UserName String 用户名,长度限制:64个字符。
Password String 用户密码, 需要符合密码策略的配置。
DisplayName String 昵称,长度限制:64个字符。 默认与用户名相同。
Description String 用户备注,长度限制:512个字符。
UserGroupIds.N Array of String 用户所属用户组ID列表。
Phone String 用户手机号。例如:+86-1xxxxxxxxxx。
OrgNodeId String 用户所属的主组织机构唯一ID。如果为空,默认为在根节点下创建用户。
ExpirationTime String 用户过期时间,遵循 ISO 8601 标准。
Email String 用户邮箱。
PwdNeedReset Boolean 密码是否需要重置,为空默认为false不需要重置密码。
SecondaryOrgNodeIdList.N Array of String 用户所属的次要组织机构ID列表。

3. 输出参数

参数名称 类型 描述
UserId String 返回的新创建的用户ID,是该用户的全局唯一标识。
注意:此字段可能返回 null,表示取不到有效值。
示例值:id
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: eiam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUser
<公共请求参数>

{
    "UserName": "示例用户",
    "DisplayName": "创建示例用户",
    "Description": "接口创建的示例用户",
    "Phone": "+86-133****6881",
    "OrgNodeId": "7999987a-****-4dd2-b3e2-b52f53317aa6",
    "ExpirationTime": "2022-01-18T09:44:07.182+0000",
    "Password": "q6E7@#8",
    "Email": "63****2556@qq.com",
    "PwdNeedReset": "true"
}

输出示例

{
    "Response": {
        "RequestId": "a31e9877-****-45f9-9765-0f36e005ceea",
        "UserId": "2877f61b-****-46f4-a6cb-eebd3cce660a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.CreateUserFailure 创建用户异常。
FailedOperation.DescribeOrgNodeRootError 读取根机构节点信息失败。
FailedOperation.LimitQuotaNotEnough 同一个应用,相同的用户不能添加超过 %s 个映射关系。
FailedOperation.MainOrgNodeNotExist 主组织机构不存在。
FailedOperation.OperationError 操作失败。
FailedOperation.OrgNodeSettingError 组织机构设置失败,组织机构不可同时被选择为用户所属的主组织和次要机构。
FailedOperation.SecondaryOrgNodeDuplicates 次要机构元素重复。
FailedOperation.UserEmailAlreadyExists 用户邮箱已存在。
FailedOperation.UserNameAlreadyExists 用户名字已存在。
FailedOperation.UserPhoneAlreadyExists 用户手机已存在。
InvalidParameter.AttributeValueValidError 属性校验失败。
InvalidParameter.UserExpirationTimeIllegal 设定的用户过期时间不合法。
InvalidParameterValue.ParameterIllegal 参数不合法。
LimitExceeded.SecondaryNodeCountLimitExceeded 用户的次要机构超出数量上限。