ExternalSharingRestrictions Data Type

Restrictions for sharing with external users.

Properties
name data type description
mode string The sharing restriction mode.

Allowed values are:

  • none: there are no domain or email restrictions for users with rights to share with external users.
  • whitelist: users with external sharing rights can only share with listed email addresses and email domains.
  • blacklist: users with external sharing rights can share with any email address except those listed.
email_list array of string List of email address that are acceptable (whitelist mode) or unacceptable (blacklist mode)
domain_list array of string List of email domains that are acceptable (whitelist mode) or unacceptable (blacklist mode)
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

{
  "mode" : "...",
  "email_list" : [ "...", "..." ],
  "domain_list" : [ "...", "..." ],
  "href" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ]
}