Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Creating Users in Batches

Updated on 2024-01-10 GMT+08:00

View PDF

Creating Users in Batches

Create users in batches.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

POST /v2/{project_id}/users/batch-create

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
users	Yes	Array of CreateUserRequest objects	Request for creating a single user.

**Table 4** CreateUserRequest
Parameter	Mandatory	Type	Description
user_name	Yes	String	Username.
user_email	No	String	User mailbox.
account_expires	No	String	Account expiration time. 0 indicates that the account never expires. The time format is yyyy-MM-ddTHH:mm:ssZ or yyyy-MM-ddTHH:mm:ss.SSSZ.
active_type	No	String	Activation type. The default value is USER_ACTIVATE. USER_ACTIVATE: activated by the user ADMIN_ACTIVATE: activated by the administrator
user_phone	No	String	Mobile number of the user.
password	No	String	Initial user password. This parameter is required for the administrator activation mode.
enable_change_password	No	Boolean	Indicates whether a user can change the password. The default value is true. This field will be invalid later on and will be set to true during creation.
next_login_change_password	No	Boolean	Whether the password must be changed upon the next login. The default value is true. This field will be invalid later on and will be set to true during creation.
group_ids	No	Array of strings	Dedicated IDs of the user group.
description	No	String	User description. The value contains a maximum of 255 characters.
alias_name	No	String	Alias.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/users/batch-create

{
  "users" : [ {
    "user_name" : "abc",
    "user_email" : "xxx@mail.com"
  } ]
}

None

Status Code	Description
200	Response to the request for creating a Workspace user.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.