Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Creating Users in Batches
Updated on 2025-07-14 GMT+08:00

Creating Users in Batches

Function

Creates users in batches.

Debugging

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API 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, which defaults to activation by users.

  • USER_ACTIVATE: activated by users

  • ADMIN_ACTIVATE: activated by the administrator

user_phone

No

String

Mobile number of the user.

password

No

String

Initial user password, which is required for the administrator activation mode.

enable_change_password

No

Boolean

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, which contains 0 to 255 characters.

alias_name

No

String

Alias.

enterprise_project_id

No

String

Enterprise project ID.

user_info_map

No

String

User information mapping, including the service level, operation mode and type.

Response Parameters

Status code: 200

Response to the request for creating Workspace users in batches.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

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

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

Example Responses

None

Status Codes

Status Code

Description

200

Response to the request for creating Workspace users in batches.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.