- Home
- Resources
- Share Settings
GET /admin/share_settings
Gets the current Share Settings
Response Body
media type |
data type |
description |
application/json |
ShareSettings
(JSON) |
The Share Settings |
application/xml |
shareSettings
(XML) |
PUT /admin/share_settings
Updates the current Share Settings. Only the fields that are included in the request body will be updated.
For example, if the request body is {"allow_sharing_with_ldap_groups":false}
, the permissions and
external restrictions settings will not change. Only the "Allow sharing with LDAP groups" setting will be updated.
Response Body
media type |
data type |
description |
application/json |
ShareSettings
(JSON) |
The Share Settings |
application/xml |
shareSettings
(XML) |
GET /admin/share_settings/permissions
Gets the list of sharing permissions that have been configured.
POST /admin/share_settings/permissions
Assign sharing permissions for a particular user or group. If the user or group has already been assigned
sharing permissions, those permissions will be replaced. If not, a new assigned sharing permission will be added.
PUT /admin/share_settings/permissions
Replaces the list of assigned sharing permissions.
DELETE /admin/share_settings/permissions
Deletes the full list of assigned sharing permissions.
Response Codes
code |
condition |
204 |
The list is deleted successfully |
GET /admin/share_settings/external_restrictions
Gets the current restrictions for sharing with external users. This is a
whitelist or blacklist of email addresses and domains.
PUT /admin/share_settings/external_restrictions
Updates the restrictions for sharing with external users. Only the fields that are included in the request body
will be modified. For example, a request body of {"domain_list":["microfocus.com","novell.com"]}
will replace the current list of domains, but will not modify the mode (blacklist/whitelist/none) nor the list of
email addresses.