Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 2.89 KB

CheckDocServiceUrlRequestDto.md

File metadata and controls

34 lines (26 loc) · 2.89 KB

CheckDocServiceUrlRequestDto

The ONLYOFFICE Docs connection settings to store and verify.

Properties

Name Type Description Notes
doc_service_url str The public address of the Document Server, the one a browser loads the editor from. An empty value drops the portal's own setting, so the address configured for the deployment takes over again. A value with no scheme is stored with http:// prepended, and an absolute address may not carry a query string.
doc_service_url_internal str The address the portal itself uses for its server-to-server calls to the Document Server, for deployments where that traffic stays inside the private network. Left empty, those calls go to the public address instead. [optional]
doc_service_url_portal str The address of this portal as the Document Server has to call it back on in order to fetch and save a document. Set it when the Document Server cannot resolve the portal by its public name; left empty, the portal's own resolved address is used. [optional]
doc_service_signature_secret str The shared secret that requests between the portal and the Document Server are signed with; it has to be the same value the Document Server itself is configured with, otherwise the verification of the new settings fails. It is write-only: the document service location is reported without it. [optional]
doc_service_signature_header str The name of the HTTP header the signature travels in, which has to match the header the Document Server expects. A secret without a header is not a usable pair and is rejected. [optional]
doc_service_ssl_verification bool Whether the portal validates the TLS certificate of the Document Server. With verification on, a self-signed certificate breaks the connection; with it off, any certificate is accepted, which is meant for test deployments only. Omitting the field turns verification on. [optional]

Example

from docspace_api_sdk.models.check_doc_service_url_request_dto import CheckDocServiceUrlRequestDto

# TODO update the JSON string below
json = "{}"
# create an instance of CheckDocServiceUrlRequestDto from a JSON string
check_doc_service_url_request_dto_instance = CheckDocServiceUrlRequestDto.from_json(json)
# print the JSON string representation of the object
print(CheckDocServiceUrlRequestDto.to_json())

# convert the object into a dict
check_doc_service_url_request_dto_dict = check_doc_service_url_request_dto_instance.to_dict()
# create an instance of CheckDocServiceUrlRequestDto from a dict
check_doc_service_url_request_dto_from_dict = CheckDocServiceUrlRequestDto.from_dict(check_doc_service_url_request_dto_dict)

[Back to Model list] [Back to API list] [Back to README]