Help Center/ KooDrive/ API Reference（Carrier）/ API/ User registration and provisioning/ Creating a Batch Provisioning Task
Updated on 2026-04-16 GMT+08:00
View PDF
Share

Creating a Batch Provisioning Task

Function

Create a batch provisioning task.

URI

POST /koodrive/ose/v1/user/batchRegister/create

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

Signature generated in AK/SK authentication mode.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication. The format is yyyyMMdd'T'HHmmss'Z'.

Constraints:

The time must be within 15 minutes from the current time and cannot be later than the current time.

Range:

N/A

Default Value:

N/A

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app authentication.

Constraints:

N/A

Value range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

userList

Yes

Array of RegisterUserInfo objects

List of provisioned users. Length: 1,000.
Table 3 RegisterUserInfo

Parameter

Mandatory

Type

Description

firstname

Yes

String

Name.

surname

No

String

Family name.

phone

Yes

String

Mobile number.

email

No

String

Email address.

password

No

String

Password.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Error Codes

msg

String

Error description.

data

String

Task ID.

Example Requests

POST /koodrive/ose/v1/user/batchRegister/create

{
  "userList" : [ {
    "firstname" : "1204",
    "surname" : "1204",
    "phone" : "1884609076404",
    "email" : "1024@12.com",
    "password" : "Q!@1assword"
  }, {
    "firstname" : "1205",
    "surname" : "1205",
    "phone" : "1884609076405",
    "email" : "1052@12.com",
    "password" : "paO2*ssword"
  } ]
}

Example Responses

Status code: 200

User provisioning response

{
  "data" : "1893596414966089600",
  "code" : 0,
  "msg" : "Success"
}

Status Codes

Status Code

Description

200

User provisioning response