externalSharingRestrictions Data Type

Restrictions for sharing with external users.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs wrapped by description
domain string element 0/unbounded domain_list List of email domains that are acceptable (whitelist mode) or unacceptable (blacklist mode)
email string element 0/unbounded email_list List of email address that are acceptable (whitelist mode) or unacceptable (blacklist mode)
mode string element 0/1   The sharing restriction mode. Allowed values are "none", "whitelist" and "blacklist" If "none", there are no domain or email restrictions for users with rights to share with external users If "whitelist", users with external sharing rights can only share with listed email addresses and email domains If "blacklist", users with external sharing rights can share with any email address except those listed.
Properties inherited from baseRestObject
href string element 0/1   The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
link link element 0/unbounded links Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<external_sharing_restrictions>
  <mode>...</mode>
  <email_list>
    <email>...</email>
  </email_list>
  <domain_list>
    <domain>...</domain>
  </domain_list>
  <href>...</href>
  <links>
    <link>
      <href>...</href>
      <rel>...</rel>
    </link>
  </links>
</external_sharing_restrictions>