文档中心

ArkClaw 企业版

UserManagement

CreateUsers - 批量创建用户

批量创建用户。

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreateUsers

要执行的操作，取值：CreateUsers。

Version string 必选示例值：2026-05-01

API的版本，取值：2026-05-01。

Users object[] 必选示例值：--

批量创建用户。

ExternalProviderUserIdentifier string 可选示例值：on_4fade80ffb71dc39fcbdd863331d****

外部身份提供商用户唯一标识。

Name string 可选示例值：zhang**

用户姓名。最大255字符。

PreferredUsername string 可选示例值：zhang**

用户名。

要求6～64字符，只能包含字母、数字、“.”、“_”、“-”，不能包含连续“..”，不能以数字开头。

若它本身是合法email形态，则必须等于该用户的Email。

说明

PreferredUsername、Email、PhoneNumber至少需要传一个，不可全部为空。

Password string 可选示例值：********

用户登录密码。

当空间认证类型为password时必填，非password空间禁止传入。

密码8～64位。

Email string 可选示例值：zhang**@example.com

用户的邮箱地址。

说明

PreferredUsername、Email、PhoneNumber至少需要传一个，不可全部为空。

PhoneNumber string 可选示例值：+86138****8000

用户手机号。

必须能按未知 region ZZ 解析为号码，即号码必须自带国家代码（如 +86）。

必须是有效号码。

号码类型必须是MOBILE或FIXED_LINE_OR_MOBILE。

输入字符串必须已经是严格E.164格式。

说明

PreferredUsername、Email、PhoneNumber至少需要传一个，不可全部为空。

SpaceId string 必选示例值：csi-yei8347ta8xmf5qd****

ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

UserResults object[] 示例值：--

创建结果。

Error object 示例值：--

错误详情。

Code string 示例值：--

返回码。

Message string 示例值：--

返回信息。

Index integer 示例值：--

错误索引，对应Users中索引。

UserId string 示例值：22e122d8-f804-4a86-999f-ddd1aada****

成功创建的用户的ID。

请求示例

POST /?Action=CreateUsers&Version=2026-05-01 HTTP/1.1​
Host: https://arkclaw.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260519T133914Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260519/cn-beijing/arkclaw/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "SpaceId": "csi-yei8347ta8xmf5qd****",​
  "Users": [​
    {​
      "Name": "zhang**",​
      "Email": "zhang**@example.com"​
    }​
  ]​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20260519214016196094****",​
    "Action": "CreateUsers",​
    "Version": "2026-05-01",​
    "Service": "arkclaw",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "UserResults": [​
      {​
        "Error": null,​
        "Index": 0,​
        "UserId": "22e122d8-f804-4a86-999f-ddd1aada****"​
      }​
    ]​
  }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter.Email	The specified Email format is invalid.	参数Email格式非法。
400	InvalidParameter.EmailVerified	The specified Email is already verified by another user.	邮箱已被其他用户验证。
400	InvalidParameter.ExternalProviderUserIdentifier	The specified ExternalProviderUserIdentifier format is invalid.	参数ExternalProviderUserIdentifier格式非法。
400	InvalidParameter.Name	The specified Name format is invalid.	参数Name格式非法。
400	InvalidParameter.Password	The specified Password format is invalid.	参数Password格式非法。
400	InvalidParameter.PhoneNumber	The specified PhoneNumber format is invalid.	参数PhoneNumber格式非法。
400	InvalidParameter.PhoneNumberVerified	The specified PhoneNumber is already verified by another user.	手机号已被其他用户验证。
400	InvalidParameter.PreferredUsername	The specified PreferredUsername format is invalid.	参数PreferredUsername格式非法。
400	InvalidParameterCombination	Incorrect combination of parameters.	参数组合非法。
400	MissingParameter.SpaceId	The required parameter SpaceId is not supplied.	参数SpaceId不能为空。
400	MissingParameter.Users	The required parameter Users is not supplied.	参数Users不能为空。
404	InvalidSpace.NotFound	The specified space does not exist.	指定的ClawSpace不存在。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.06.16 22:27:08

这个页面对您有帮助吗？

有用

无用