Set permission - Cloudreve API Docs

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params application/json

uris

array[string]

required

List of URI of the target files.

>= 1 items

setting

object (PermissionSetting)

required

Permission setting for different groups/users. Encoded as boolset.

user_explicit

object

optional

Map of explicit permission setting from user ID to boolset.

group_explicit

object

optional

Map of explicit permission setting from group ID to boolset.

same_group

string

optional

Permission for users under the same group as the file owner.

other

string

optional

Permission for users under the different groups as the file owner.

anonymous

string

optional

Permission for anonymous users.

Example:

AQ==

everyone

string

optional

Permission for everyone else.

Example:

AQ==

Example

{
    "uris": [
        "cloudreve://my/newfile.docx",
        "cloudreve://my/main.c"
    ],
    "setting": {
        "user_explicit": {
            "bnUn": "Dw=="
        },
        "same_group": "Dw==",
        "anonymous": "Aw==",
        "everyone": "Cw=="
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/file/permission' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uris": [
        "cloudreve://my/newfile.docx",
        "cloudreve://my/main.c"
    ],
    "setting": {
        "user_explicit": {
            "bnUn": "Dw=="
        },
        "same_group": "Dw==",
        "anonymous": "Aw==",
        "everyone": "Cw=="
    }
}'

Responses

🟢200Success

application/json

Body

code

integer

required

Response code.
0 - Success.

Default:

0

Example:

0

msg

string

optional

Human readable error message (if any).

error

string | null

optional

Internal error message, only visable in debug mode.

aggregated_error

object | null

optional

Map of multiple error in batch request. The key is the failed resource ID, it could be a file URI or a resource ID, the value is a Response.

Additional properties

object (Response)

optional

correlation_id

string <uuid> | null

optional

Correlation ID of the request. Only presented on failed reqeust.

Example:

b4351ecc-ee1a-4455-bc94-2c3dbcc58538

Example

{
    "code": 0,
    "msg": ""
}