Help Center/ KooDrive/ API Reference/ API/ User Management/ Pre-verification API
Updated on 2025-03-07 GMT+08:00
View PDF
Share

Pre-verification API

Function

Pre-verification API.

URI

POST /koodrive/ose/v1/users/batchimport/preverify

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

language

No

String

Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

X-Traceid

No

String

Message log trace ID. The value contains 58 bits.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

curDeptId

Yes

Integer

ID of the selected department.

users

Yes

Array of ImportUserInfo objects

Imported user information.
Table 3 ImportUserInfo

Parameter

Mandatory

Type

Description

targetDeptName

No

String

Name of the target department.

personalCapacity

Yes

Integer

Capacity of the allocated individual space. If isAllocateCapacity is set to false, the value is 0.

isAllocateCapacity

Yes

Boolean

Whether the individual space is allocated.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

Integer

Response code.

msg

String

Response message.

data

Array of ImportUserVerifyResult objects

Result.
Table 5 ImportUserVerifyResult

Parameter

Type

Description

isSuccess

Integer

Import result (successful or failed).

reason

String

Failure reason.

Example Requests

Performing Pre-verification

/koodrive/ose/v1/users/batchimport/preverify

{
  "curDeptId": 1575416580416769793
  "users": [
     {
         "targetDeptName": "Dept",
          "personalCapacity":  10,
          "isAllocateCapacity": true
     }
            ]
}

Example Responses

Status code: 200

Response body of the pre-verification API.

{
  "code": 0,
  "msg": "Successful",
   "data": [
                 "isSuccess": 0
           ]
}

Status Codes

Status Code

Description

200

Response body of the pre-verification API.
Parent topic: User Management