Share a library to user/group

put

https://{server}/api2/repos/{repo_id}/dir/shared_items/

Share the current user's existing library with other users or groups.

username/group_id can be repeated to share with several recipients at once; per-recipient errors are reported in failed.
Sharing to a department requires being admin of that department; sharing to a group the user is not a member of is only possible if the server allows sharing to all groups.
In organizations, recipients must belong to the same organization.

Requires the role permission to share libraries; only the library owner or a user with admin share permission may manage shares.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

repo_id

string

required

^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The unique identifier of a library

Query Params

string

enum

/ means the root folder, which is equivalent to the library.

Allowed:

Body Params

share_type

string

enum

required

Allowed:

permission

string

Defaults to r

Share permission: r (read-only), rw (read-write) or admin (read-write plus the right to manage shares). SecureCloud Pro additionally accepts cloud-edit (online preview and edit only), preview (online preview only) and invisible, as well as custom permissions in the form custom-<id>. Default: r.

username

array of strings

Required if share_type is user. Username (account ID) of the recipient; repeat the form field to share with several users.

username

group_id

array of integers

Required if share_type is group. Group ID; repeat the form field to share with several groups.

group_id

Responses

Language

Credentials

Bearer

Account-Token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Invalid share_type or permission, or sharing to the library owner.

403No permission to share this library.

404Library not found.