Updated on 2026-02-12 GMT+08:00

Binding Devices to a User

Function

Binding devices to a user.

URI

POST /koodrive/ose/v1/backup/device

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

This field stores the 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.

Constraints:

The format is bearer+access token.

Range:

For details about how to obtain an access token, see the corresponding developer guide.

Default Value:

N/A

X-User-Id

Yes

String

Definition:

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

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Signature time, which is used for app ID authentication.

Constraints:

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

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

Definition:

Signature time, which is used for app ID authentication.

Constraints:

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

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

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

machineCode

Yes

String

Definition:

Machine code.

Constraints:

^[a-zA-Z0-9_]{1,64}$

Range:

The maximum length is 64.

Default Value:

N/A

deviceName

No

String

Definition:

Device name.

Constraints:

^[a-zA-Z0-9-_\s]{1,32}$

Range:

The maximum length is 32.

Default Value:

N/A

deviceOS

No

String

Definition:

Device system.

Constraints:

^[a-zA-Z0-9_\s]{1,32}$

Range:

The maximum length is 32.

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

Integer

Status code.

msg

String

Status description.

data

BoundDeviceEntity object

Device data.

Table 4 BoundDeviceEntity

Parameter

Type

Description

deviceId

String

Device ID.

machineCode

String

Machine code.

deviceName

String

Device name.

deviceOS

String

Device system.

createTime

String

Creation time.

Example Requests

Example request for binding devices to a user.

/koodrive/{{service}}/v1/backup/device

Authorization:Bearer+60f4ccc7b1********3dd9a68068
{
    "machineCode": "20251217",
    "deviceName": "Magic-v5",
    "deviceOS": "android"
}

Example Responses

Status code: 200

Response body for binding devices to a user.

{
  "data" : {
    "deviceId" : "1842812272691451648",
    "machineCode" : "20251217",
    "deviceName" : "Magic-v5",
    "deviceOS" : "android",
    "createTime" : "2025-12-17T06:19:01.803Z"
  },
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response body for binding devices to a user.