SharingPolicy_1_0_0
SharingPolicy_1_0_0 Document
Sharing policies for a mapped collection.
This document type allows endpoint and collection administrators to optionally constrain sharing path policies for particular users. The sharing_restrict_paths property has a similar meaning to that of the sharing_restrict_paths in the collection document; however, it is in effect only for specific users.
If the users property is null, then the restriction applies to all users. If it is non-null, then this restriction applies only to accounts which have been mapped to the enumerated storage gateway user accounts.
Multiple sharing policies can be defined for a mapped collection. When a guest collection is created or accessed, only the policies relevant to the user which created the account are enforced.
Name |
Type |
Description |
DATA_TYPE |
string |
Type of this document |
collection_id |
string <uuid> |
Id of the mapped collection which this policy is associated with |
id |
string <uuid> |
Unique id for this sharing policy |
sharing_restrict_paths |
Restrictions on which paths may be shared in guest collections related to this mapped collection. These paths are relative to the root_path property of the mapped collection. |
|
users |
array of string |
List of local user accounts that this policy applies to. If omitted or null, this restriction applies to all local user accounts. |
{
"DATA_TYPE": "sharing_policy#1.0.0",
"collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_restrict_paths": {
"DATA_TYPE": "path_restrictions#1.0.0",
"none": [
"string"
],
"read": [
"string"
],
"read_write": [
"string"
]
},
"users": [
"string"
]
}