updateTenantConfig
DocsCloudConfigWrapper updateTenantConfig(DocsCloudConfigRequestDto)
PUT /api/2.0/settings/docscloud/tenant/config
Update the Docs Connect tenant configuration
Replaces the configuration of the Docs Connect tenant of the current portal: its name, the security secret and header name, the file size limit and anonymous access switch of the server, the WOPI switch and the IP filter rules; it returns the configuration as Docs Connect stored it. The portal must have an activated Docs Connect tenant, granted by POST api/2.0/settings/docscloud/trial or by a Docs Connect purchase: an empty result from GET api/2.0/settings/docscloud/tenant means there is none and this call fails with 400. Read the current values with GET api/2.0/settings/docscloud/tenant/config first and send back whole sections: the sections left out of the request are not sent to Docs Connect at all, while a section that is present is sent with all of its fields, so a field left unset inside it goes out as 0, false or empty. The caller must be a portal administrator allowed to edit the portal settings, on an installation where the Docs Connect service is configured. The call is mutating, synchronous and idempotent, it is recorded in the portal audit trail, and it drops the cached configuration itself, so the next read returns the new values without refresh=true. The tenantName, security.secret, security.header and every ipFilter.rules address are capped at 255 characters and server.fileSizeLimit at 209715200 bytes (200 MB); a value outside those bounds is rejected with 400 before anything reaches Docs Connect. It changes these settings only, never the subscription, the user quota or the license.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| DocsCloudConfigRequestDto | body | DocsCloudConfigRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The configuration of the Docs Connect tenant as Docs Connect stored it after the update | DocsCloudConfigWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read, a text field is longer than 255 characters, the file size limit is outside 0-209715200 bytes, or the portal has no activated Docs Connect tenant | - | - |
| 403 | The caller has no portal-settings right | - | - |
| 500 | The Docs Connect service is not configured on this installation, is unreachable, or answered with an error other than not found, including a rejection of the new values | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json