ShareSettings Data Type

Global Share Settings.

Properties
name data type description
allow_sharing_with_ldap_groups boolean Whether or not users can share with LDAP groups.
external_restrictions ExternalSharingRestrictions Restricts sharing with external users by email address or email domain.
sharing_permissions array of AssignedSharingPermission List of users and groups who have been assigned permissions to share.
Properties inherited from BaseRestObject
href string The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
links array of Link Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

{
  "allow_sharing_with_ldap_groups" : true,
  "sharing_permissions" : [ {
    "principal" : {
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "sharing" : {
      "external" : true,
      "internal" : true,
      "all_internal" : true,
      "all_external" : true,
      "public" : true,
      "public_link" : true,
      "grant_reshare" : true
    }
  }, {
    "principal" : {
      "type" : "...",
      "id" : 12345,
      "href" : "..."
    },
    "sharing" : {
      "external" : true,
      "internal" : true,
      "all_internal" : true,
      "all_external" : true,
      "public" : true,
      "public_link" : true,
      "grant_reshare" : true
    }
  } ],
  "external_restrictions" : {
    "mode" : "...",
    "email_list" : [ "...", "..." ],
    "domain_list" : [ "...", "..." ],
    "href" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ]
  },
  "href" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ]
}