Help Center/ KooDrive/ API Reference/ API/ Sharing Management - Access Links/ Obtaining Sharing Information
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Obtaining Sharing Information

Function

Obtain sharing information.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /koodrive/ose/v1/share/userInfo

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

shortUrl

Yes

String

Sharing short code.

Request Parameters

Table 2 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}.

X-Traceid

No

String

Service trace ID, which contains 58 bits.

X-User-Id

Yes

String

User ID, which is used for app authentication.

X-Date

Yes

String

Date, which is used for app authentication.

Host

Yes

String

Address, which is used for app authentication.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

Integer

Response code.

msg

String

Response information.

link

CommonShareLink object

Public information of the access link.
Table 4 CommonShareLink

Parameter

Type

Description

shareId

String

Sharing ID.

shortUrl

String

Sharing short code.

shareTime

String

Time when the file is shared.

ownerId

String

Sharer ID.

ownerName

String

Sharer name.

permission

SharePermission object

Sharing permission (supported in the future).

expireTime

String

Expiration time.

status

Integer

Sharing status. 0: determined based on the expiration time. 1: The file has been deleted. 2: expired.

expireDate

String

Validity period.
Table 5 SharePermission

Parameter

Type

Description

preview

Boolean

Preview permission.

edit

Boolean

Editing permission.

download

Boolean

Download permission.

Example Requests

GET /koodrive/ose/v1/share/userInfo?shortUrl=String

Authorization:Bearer+10f88*************5a544791e9ff

Example Responses

Status code: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "link" : {
    "shareId" : "string",
    "shortUrl" : "string",
    "shareTime" : "2024-06-03T02:20:24.274Z",
    "ownerId" : "string",
    "ownerName" : "string",
    "permission" : {
      "preview" : true,
      "edit" : true,
      "download" : true
    },
    "expireTime" : "2024-06-03T02:20:24.274Z",
    "expireDate" : "3",
    "status" : 0
  }
}

Status Codes

Status Code

Description

200

OK