创建便捷账号用户。
接口说明
便捷用户是无影专用的账号体系,适用于不希望对接企业 AD 的简单场景。便捷用户信息包括用户名、邮箱和手机号。其中,用户名为必填信息,邮箱和手机号至少填写一项。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Users | object [] | 是 | 便捷用户信息。 | CreateUsers |
EndUserId | string | 是 | 用户名。自定义设置,由小写字母、数字和下划线组成,长度为 3~24 个字符。 | test1 |
string | 否 | 邮箱。用于接收相关邮件,如分配云电脑的通知邮件。邮箱和手机号二选一必填。 | username@example.com | |
Phone | string | 否 | 手机号。用于接收相关短信,如分配云电脑的通知短信。邮箱和手机号二选一必填。 | 1381111**** |
Password | string | 否 | 用户密码。 说明
密码长度不少于 10 位,且至少包含大写字母、小写字母、数字、特殊字符(除空格)中的任意三种。
| password1 |
OwnerType | string | 否 | 账号归属类型。 枚举值:
| Normal |
OrgId | string | 否 | 用户所属的组织。 | 1111**** |
Remark | string | 否 | 用户备注。 | remark1 |
RealNickName | string | 否 | 用户的显示名。 | Bean |
Password | string | 否 | 初始密码。如果不设置,将发送重置密码邮件到用户邮箱。 | Test123**** |
AutoLockTime | string | 否 | 自动锁定用户的日期,到期后用户将自动锁定。 | 2023-03-03 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"CreateResult": {
"CreatedUsers": [
{
"EndUserId": "test1",
"Email": "username@example.com",
"Phone": "1381111****",
"Remark": "remark1",
"RealNickName": "Bean"
}
],
"FailedUsers": [
{
"EndUserId": "test2",
"Email": "username2@example.com",
"Phone": "1390000****",
"ErrorCode": "ExistedEndUserId",
"ErrorMessage": "The username test is used by another user."
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | INTERNAL_ERROR | Internal error. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-01-16 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-08-31 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2021-04-02 | 新增 OpenAPI | 看变更集 |