Skip to main content

changeAccessToThirdparty

BooleanWrapper changeAccessToThirdparty(SettingsRequestDto)

PUT /api/2.0/files/thirdparty

Change the third-party settings access

Turns the portal-wide permission to connect third-party storages such as Google Drive, Dropbox or Nextcloud on or off, and returns the value that is now stored. Only the portal owner and a DocSpace administrator may change it: a room administrator, a member or a guest is refused, and so is an unauthenticated caller. This is a single setting for the whole portal rather than a preference of the caller, so it changes what every account sees. While it is off, connecting an account through POST api/2.0/files/thirdparty is refused and the contents of an already connected provider folder cannot be listed; the stored connections themselves survive and work again once it is turned back on. The providers this portal can offer are listed by GET api/2.0/files/thirdparty/capabilities. The same value is published as enableThirdParty by GET api/2.0/files/settings. Sending the same value again is safe. The response is the value read back from the portal, not a success flag.

Parameters​

NameInTypeDescriptionNotes
SettingsRequestDtobodySettingsRequestDto[optional]

Responses​

Status codeDescriptionTypeResponse headers
200true if third-party storages may be connected in this portalBooleanWrapperX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
403The caller is not a DocSpace administrator--
401UnauthorizedErrorApiResponse-
429Too Many Requests.ErrorApiResponseRetry-After
500Internal Server Error.ErrorApiResponse-
400Bad Request.ErrorApiResponse-
502Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON.--
503Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON.--

Return type​

BooleanWrapper

Authorization​

Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json