Settings#
EmailSenderCompany#
Settings entry for email sender
message EmailSenderCompany {
optional string default_name = 1;
optional string company_name = 2;
optional string name = 3;
EmailSenderCompanyType type = 4;
}
Field |
Type |
Description |
|---|---|---|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
SettingsEntryAsListView#
message SettingsEntryAsListView {
ListView value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See ListView |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsEmailSenderCompany#
Settings entry for email sender name
message SettingsEntryAsEmailSenderCompany {
EmailSenderCompany value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsTrashBin#
Settings entry for trash bin
message SettingsEntryAsTrashBin {
EmptyTrashBin value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See EmptyTrashBin |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsHideExpired#
Setiings entry for hide expired documents
message SettingsEntryAsHideExpired {
HideExpiredDocuments value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsDownloadListFormat#
Settings entry for download format
message SettingsEntryAsDownloadListFormat {
DownloadListFormat value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsAutoLogOff#
Settings entry for automatic logoff
message SettingsEntryAsAutoLogOff {
AutoLogOff value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See AutoLogOff |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsLoginVerification#
Settings entry for the login verification
message SettingsEntryAsLoginVerification {
LoginVerification value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsPasswordMinLength#
Settings entry for password min length
message SettingsEntryAsPasswordMinLength {
PasswordMinLength value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsPasswordChange#
Settings entry for password change interval
message SettingsEntryAsPasswordChange {
PasswordChangeInterval value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsPasswordReset#
Settings entry for password reset options
message SettingsEntryAsPasswordReset {
PasswordResetOption value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See PasswordResetOption |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsSortIndex#
Settings entry for password reset options
message SettingsEntryAsSortIndex {
SortIndexOption value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See SortIndexOption |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsDefaultVisibility#
Settings entry for visibility
message SettingsEntryAsDefaultVisibility {
DefaultVisibilityOption value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsSendInformationEmails#
Settings entry for information emails
message SettingsEntryAsSendInformationEmails {
SendInformationEmailsOption value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsCommentVisibility#
Settings entry for comments visibility
message SettingsEntryAsCommentVisibility {
CommentVisibilityOption value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsThemeMode#
Settings entry for theme mode
message SettingsEntryAsThemeMode {
ThemeMode value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See ThemeMode |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsAccentColor#
Settings entry for theme mode
message SettingsEntryAsAccentColor {
AccentColor value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See AccentColor |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsUserNotification#
Settings entry for user notification
message SettingsEntryAsUserNotification {
UserNotification value = 1;
bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
See UserNotification |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsTwoFactorType#
Settings entry for 2FA type
message SettingsEntryAsTwoFactorType {
TwoFactorType value = 1;
bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
See TwoFactorType |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsSalutation#
Settings entry for salutation
message SettingsEntryAsSalutation {
Salutation value = 1;
bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
See Salutation |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsLanguage#
Settings entry for language
message SettingsEntryAsLanguage {
Language value = 1;
bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
See Language |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsLocale#
Setting entry for locales.
message SettingsEntryAsLocale {
Locale value = 1;
bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
See Locale |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsEncryptionType#
Setting entry for encription types.
message SettingsEntryAsEncryptionType {
EncryptionType value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See EncryptionType |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsManagedFiletransferVisibility#
Settings entry mft visibility
message SettingsEntryAsManagedFiletransferVisibility {
ManagedFiletransferVisibility value = 1;
bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsInviteValidDays#
Settings entry for invite valid days
message SettingsEntryAsInviteValidDays {
InviteValidDays value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See InviteValidDays |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
WatermarkLayoutPosition#
Defines the position of watermark
message WatermarkLayoutPosition {
optional WatermarkLayoutHorizontalPosition horizontal = 1;
optional WatermarkLayoutVerticalPosition vertical = 2;
optional WatermarkLayoutRotation rotation = 3;
WatermarkLayoutPositionType type = 4;
}
Field |
Type |
Description |
|---|---|---|
|
|
Optional. See WatermarkLayoutHorizontalPosition |
|
|
Optional. See WatermarkLayoutVerticalPosition |
|
|
Optional. See WatermarkLayoutRotation |
|
|
WatermarkTextLayout#
Layout for text part of watermark
message WatermarkLayoutText {
optional bool user_name = 1;
optional bool user_email = 2;
optional bool dataroom_name = 3;
optional bool date = 4;
optional string custom_text = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
WatermarkLayout#
Layout for custom watermark
message WatermarkLayout {
optional string font = 1;
optional uint32 font_size = 2;
optional string font_weight = 3;
optional string color = 4;
optional float opacity = 5;
optional WatermarkLayoutText text = 6;
optional WatermarkLayoutPosition position = 7;
}
Field |
Type |
Description |
|---|---|---|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional See:ref:WatermarkLayoutText <WatermarkLayoutText> |
|
|
Optional See:ref:WatermarkLayoutPosition <WatermarkLayoutPosition> |
WatermarkLayouts#
Array of different layouts
message WatermarkLayouts {
repeated WatermarkLayout layouts = 1;
}
Field |
Type |
Description |
|---|---|---|
|
|
See :ref: WatermarkLayout <WatermarkLayout> |
SettingsEntryAsWatermarkLayouts#
Settings entry for watermark layouts
message SettingsEntryAsWatermarkLayouts {
WatermarkLayouts value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See :ref: WatermarkLayouts <WatermarkLayouts> |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsActivityLogStoragePeriod#
Settings entry for ActivityLogStoragePeriod
message SettingsEntryAsActivityLogStoragePeriod {
ActivityLogStoragePeriod value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See :ref: ActivityLogStoragePeriod <ActivityLogStoragePeriod> |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsSendAuthenticationType#
Default auth setting for send
message SettingsEntryAsSendAuthenticationType {
SendAuthenticationType value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See :ref: SendAuthenticationType <SendAuthenticationType> |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsSendAutoDeleteType#
Default auth setting for send
message SettingsEntryAsSendAutoDeleteType {
SendAutoDeleteType value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See :ref: SendAutoDeleteType <SendAutoDeleteType> |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
RootQuota#
message RootQuota {
ItemType root_type = 1;
uint64 used_size = 2;
}
Field |
Type |
Description |
|---|---|---|
|
|
See :ref: ItemType <ItemType> |
|
|
SettingsEntryAsRootQuota#
How much quota is used per root
message SettingsEntryAsRootQuota {
repeated RootQuota value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
array of |
See :ref: RootQuota <RootQuota> |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
DocumentStateDefinitionEntry#
Defines one entry for a document state (text, color).
The optional field not_editable refers to which state cannot be edited and must be entered as the sum of the values related to their field:
text= 1color= 2enabled= 4
Eg. Text and color not editable means not_editable= 3
message DocumentStateDefinitionEntry {
string text = 1;
string color = 2;
bool enabled = 3;
// protolint:disable:next MAX_LINE_LENGTH
optional uint32 not_editable = 4; // text=1, color=2, enabled=4; so making e.g. text and color not editable means not_editable= 3;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Optional text=1, color=2, enabled=4; so making e.g. text and color not editable means not_editable= 3 |
DocumentStateDefinitions#
List of document states defined
message DocumentStateDefinitions {
map<string, DocumentStateDefinitionEntry> states = 1;
}
Field |
Type |
Description |
|---|---|---|
|
|
SettingsEntryAsDocumentStateDefinitions#
Settings entry for document state
message SettingsEntryAsDocumentStateDefinitions {
DocumentStateDefinitions value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
InformOnOpenUser#
Represents one user to be informed on deal room opening
message InformOnOpenUser {
string title = 1;
string id = 2;
bool invite = 3;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
InformOnStatusChange#
Specifies which users to inform on opening deal room
message InformOnStatusChange {
repeated InformOnOpenUser users = 1;
optional bool inform_admins = 2;
optional bool inform_sell_side = 3;
optional bool inform_all_users = 4;
optional string message_on_invite = 5;
optional bool create_backup = 6;
}
Field |
Type |
Description |
|---|---|---|
|
array of |
See InformOnOpenUser |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsInformOnStatusChange#
Settings entry for informing members when changing deal room status
message SettingsEntryAsInformOnStatusChange {
InformOnStatusChange value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsDealroomStatus#
Deal room status as settings entry
message SettingsEntryAsDealroomStatus {
DealroomStatus value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See DealroomStatus |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
DealroomStatusHistoryEntry#
One entry of the list of deal room status changes
message DealroomStatusHistoryEntry {
// ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
google.protobuf.Timestamp creation_date = 1;
string execution_user = 2;
DealroomStatusTransition transition = 3;
}
Field |
Type |
Description |
|---|---|---|
|
|
ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ |
|
|
|
|
|
DealroomStatusHistory#
Deal room status history, list of status changes
message DealroomStatusHistory {
repeated DealroomStatusHistoryEntry value = 1;
optional bool editable = 2;
optional string tooltip_type = 3;
optional bool available = 4;
optional bool admin_editable = 5;
}
Field |
Type |
Description |
|---|---|---|
|
array of |
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
DataroomSettings#
Settings for the data room
message DataroomSettings {
optional string dataroom_id = 1;
optional google.protobuf.Timestamp last_changed = 9;
// General
SettingsEntryAsString dataroom_name = 10;
SettingsEntryAsBool show_number_of_documents = 15; //showCOllectionSize
SettingsEntryAsDownloadListFormat download_list_format = 16;
SettingsEntryAsBool log_activity_recursive = 17; // activityLogRecursive
// NF_NotifyEmailSenderCompany
SettingsEntryAsEmailSenderCompany email_sender_name = 18;
// protolint:disable:next MAX_LINE_LENGTH
optional SettingsEntryAsActivityLogStoragePeriod activity_log_storage_period = 19;
// Documents
optional SettingsEntryAsBool require_document_approval = 30; //useApproval
SettingsEntryAsBool notify_about_changes = 31; // allowAgents
// allowAgentsUnConfirmed
SettingsEntryAsBool notify_about_changes_for_unconfirmed_users = 32;
SettingsEntryAsBool use_version_control = 33; // versionControl
SettingsEntryAsBool use_group_labels = 34; // useGroupLabels
SettingsEntryAsBool create_office_documents = 35; //openOfficeDocuments
//showOfficeInCollabora
SettingsEntryAsBool show_office_documents_navigable = 36;
SettingsEntryAsBool create_text_documents = 37; //showDocuments
optional SettingsEntryAsBool download_instead_open = 38; // defaultDownload
SettingsEntryAsBool download_zip = 39; //defaultZipDownloads
SettingsEntryAsBool allow_folder_download = 40; // canDownloadFolderOption
SettingsEntryAsBool use_fulltext_search = 41; // createFulltextIndex
// createViewerAnnotations
optional SettingsEntryAsBool create_document_annotations = 42;
// createViewerSharedAnnotations
optional SettingsEntryAsBool create_shared_document_annotations = 43;
//SettingsEntryAsBool show_permissions_icon = 45; // showRightsIcon
optional SettingsEntryAsBool download_user_may_see_version_history = 51;
optional SettingsEntryAsHideExpired days_expired_documents_hidden = 46;
// docLivetime
SettingsEntryAsTrashBin days_empty_trash = 47; //emptyTrashDays
SettingsEntryAsBool use_private_labels = 48; // useLabels
optional SettingsEntryAsDocumentStateDefinitions document_states = 49;
optional SettingsEntryAsBool enable_document_states = 50;
// Security
SettingsEntryAsBool show_login_activity = 60;
SettingsEntryAsBool send_email_for_new_devices = 61; // showDeviceAccess
SettingsEntryAsAutoLogOff auto_logoff = 62; // newlogoutSecs
// device_access_type
SettingsEntryAsLoginVerification login_verification = 63;
SettingsEntryAsString exclude_ip_range = 64; // ipaddress
SettingsEntryAsBool scan_for_virus = 65; // virusScan
SettingsEntryAsBool encrypt_files = 66; // encryptFiles
optional SettingsEntryAsBool e2ee = 67;
SettingsEntryAsBool use_permission_read_only = 68; // prohibitDownload
SettingsEntryAsBool use_permission_download_pdf = 69; // allowPdfDownload
SettingsEntryAsBool use_watermarks_pdf = 70; // useWatermarks
optional SettingsEntryAsWatermarkLayouts watermark_layouts = 87;
SettingsEntryAsBool download_pdfs_encrypted = 71; // downloadentryptedpdf
// Password
SettingsEntryAsPasswordMinLength password_min_length = 80; //passwordMinChars
// passwordUseSpecial
SettingsEntryAsBool password_requires_special_chars = 81;
SettingsEntryAsBool password_requires_numbers = 82; // passwordUseNumbers
SettingsEntryAsBool password_requires_mixed_letters = 83; // passwordUseMixed
// passwordChangeInt
SettingsEntryAsPasswordChange password_change_interval = 84;
SettingsEntryAsPasswordReset password_reset = 85; // passwordQuestion
SettingsEntryAsBool password_reset_by_admin = 86; // passwordNoResetByAdmin
// Index
optional SettingsEntryAsBool use_file_index = 100; // showIndex
optional SettingsEntryAsBool spread_upload_by_index = 101; // indexSpread
optional SettingsEntryAsBool freeze_index = 102; // indexFreeze
optional SettingsEntryAsSortIndex sort_index = 103; //indexSortby
// User
SettingsEntryAsBool mark_unseen_documents = 110; // markseen
SettingsEntryAsBool user_may_change_rights = 111; // editRights
SettingsEntryAsBool user_may_trash_files = 112; // showBin
SettingsEntryAsBool show_admin_group = 113; // showAdmins
// doesNotSeeOthersGlobal
SettingsEntryAsDefaultVisibility default_visibility = 114;
SettingsEntryAsBool allow_emails_to_users = 115; // userToUserMailDelivery
SettingsEntryAsBool allow_emails_as_plaintext_only = 116; // plainTextEmails
SettingsEntryAsBool require_emails_copy_to_sender = 117; // emailSenderCopy
// informObserverAboutInvite
SettingsEntryAsBool send_observer_email_on_invite = 118;
//NF_InformResponsibleOnly
SettingsEntryAsSendInformationEmails send_information_emails = 119;
SettingsEntryAsBool show_introduction_dialog = 120; // showWelcome
// defineUsernames
optional SettingsEntryAsBool define_usernames_enabled = 121;
//inviteValidDuration
optional SettingsEntryAsInviteValidDays invite_valid_days = 122;
// Functions
// managedFileTransfer
optional SettingsEntryAsBool use_managed_filetransfer = 130;
// managedFileTransferUpload
optional SettingsEntryAsBool use_managed_filetransfer_local_upload = 131;
// managedFileTransferPassword
optional SettingsEntryAsBool use_managed_filetransfer_password = 132;
optional SettingsEntryAsBool use_tablet_app = 133; // ipad
optional SettingsEntryAsBool use_webdav = 134; // webdav
optional SettingsEntryAsBool use_sftp = 135; // sftp
// showVideoConference
optional SettingsEntryAsBool use_video_conferences = 138;
optional SettingsEntryAsBool use_meetings = 140; // showMeetings
optional SettingsEntryAsBool use_votings = 141; // showVotings
optional SettingsEntryAsBool show_favorites = 142; // showFavourites
optional SettingsEntryAsBool show_new_files = 143; // showNewFiles
optional SettingsEntryAsBool show_locked_files = 144; // showLocked
optional SettingsEntryAsBool show_recent_comments = 145; // showRecentComments
optional SettingsEntryAsBool show_preferred_files = 146; // showPrefered
optional SettingsEntryAsBool use_comments = 147; // showComments
//showCommentsScope
optional SettingsEntryAsCommentVisibility comment_visibility = 148;
// Disclaimer
// showDisclaimer
optional SettingsEntryAsBool use_disclaimer = 160;
optional SettingsEntryAsBool reaccept_disclaimer = 161; // disclaimerReAccept
optional SettingsEntryAsString disclaimer_text = 162; // disclaimerReAccept
// UI
SettingsEntryAsUILogo dataroom_logo = 170;
optional SettingsEntryAsBool on_upload_scale_only = 171;
SettingsEntryAsThemeMode color_scheme = 173;
SettingsEntryAsString login_page_url = 174;
// Additional
optional SettingsEntryAsBool show_password_directive = 180;
optional SettingsEntryAsBool allow_export_dataroom = 181;
optional SettingsEntryAsBool allow_import_users = 182;
optional SettingsEntryAsBool allow_time_restricted_access = 183;
optional SettingsEntryAsBool show_dataroom_index = 185;
optional SettingsEntryAsBool show_user_activities = 186;
optional SettingsEntryAsBool allow_invitation_send_later = 187;
optional SettingsEntryAsBool allow_invitation_send_as_link = 188;
optional SettingsEntryAsBool show_dataroom_settings = 189;
optional SettingsEntryAsAccentColor accent_color = 190;
optional string dataroom_logo_name = 191;
optional SettingsEntryAsBool enable_co_editing = 192;
optional SettingsEntryAsBool show_folder_activities = 193;
optional SettingsEntryAsBool allow_custom_watermarks = 194;
// Send
optional SettingsEntryAsString denylisted_email_domains = 200;
optional SettingsEntryAsDate contract_end = 201;
// Dealroom
optional SettingsEntryAsBool use_qa_comments = 220;
optional SettingsEntryAsBool use_multi_group_membership = 221;
optional SettingsEntryAsInformOnStatusChange inform_on_status_change = 222;
optional SettingsEntryAsDealroomStatus dealroom_status = 223;
optional DealroomStatusHistory dealroom_status_history = 224;
optional SettingsEntryAsBool use_dr_comments = 225;
optional SettingsEntryAsNumber allowed_permissions_buy = 226;
optional SettingsEntryAsNumber allowed_permissions_sell = 227;
// MS-Teams-Integration
optional SettingsEntryAsBool use_ms_teams = 230;
// Allow machine machine translation using DeepL
optional SettingsEntryAsBool allow_machine_translation = 233;
optional SettingsEntryAsNumber total_deep_l_used_characters = 234;
// REDACTION
// createViewerRedactions: This is the standard that we already have
optional SettingsEntryAsBool create_document_redactions = 44;
// These are new, to support smart redaction
optional SettingsEntryAsBool enable_smart_redaction = 235;
optional SettingsEntryAsBool smart_redact_new_files = 236;
optional SettingsEntryAsString smart_redaction_configuration = 237;
}
Field |
Type |
Description |
|---|---|---|
|
|
Optional |
|
|
Optional |
General |
||
|
|
|
|
|
See SettingsEntryAsBool - showCOllectionSize |
|
|
|
|
|
See SettingsEntryAsBool -activityLogRecursive |
NF_NotifyEmailSenderCompany |
||
|
|
|
|
|
Optional. See SettingsEntryAsActivityLogStoragePeriod |
Documents |
||
|
|
Optional. See SettingsEntryAsBool - useApproval |
|
|
See SettingsEntryAsBool - allowAgents |
|
|
See SettingsEntryAsBool - allowAgentsUnConfirmed |
|
|
See SettingsEntryAsBool - versionControl |
|
|
See SettingsEntryAsBool - useGroupLabels |
|
|
See SettingsEntryAsBool - openOfficeDocuments |
|
|
See SettingsEntryAsBool - showOfficeInCollabora |
|
|
See SettingsEntryAsBool - showDocuments |
|
|
Optional. See SettingsEntryAsBool - defaultDownload |
|
|
See SettingsEntryAsBool - defaultZipDownloads |
|
|
See SettingsEntryAsBool - canDownloadFolderOption |
|
|
See SettingsEntryAsBool - createFulltextIndex |
|
|
Optional. See SettingsEntryAsBool - createViewerAnnotations |
|
|
Optional. See SettingsEntryAsBool - createViewerSharedAnnotations |
|
|
Optional. See SettingsEntryAsBool - showRightsIcon |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsHideExpired - docLivetime |
|
|
See SettingsEntryAsTrashBin - emptyTrashDays |
|
|
See SettingsEntryAsBool - useLabels |
|
|
Optional. See SettingsEntryAsDocumentStateDefinitions |
|
|
Optional. See SettingsEntryAsBool |
Security |
||
|
|
|
|
|
See SettingsEntryAsBool - showDeviceAccess |
|
|
See SettingsEntryAsAutoLogOff - newlogoutSecs |
|
|
See SettingsEntryAsLoginVerification - device_access_type |
|
|
See SettingsEntryAsString - ipaddress |
|
|
See SettingsEntryAsBool - virusScan |
|
|
See SettingsEntryAsBool - encryptFiles |
|
|
Optional. See SettingsEntryAsBool |
|
|
See SettingsEntryAsBool - prohibitDownload |
|
|
See SettingsEntryAsBool - allowPdfDownload |
|
|
See SettingsEntryAsBool - useWatermarks |
|
|
Optional. See SettingsEntryAsWatermarkLayouts |
|
|
See SettingsEntryAsBool - downloadentryptedpdf |
Password |
||
|
|
See SettingsEntryAsPasswordMinLength - passwordMinChars |
|
|
See SettingsEntryAsBool - passwordUseSpecial |
|
|
See SettingsEntryAsBool - passwordUseNumbers |
|
|
See SettingsEntryAsBool - passwordUseMixed |
|
|
See SettingsEntryAsPasswordChange - passwordChangeInt |
|
|
See SettingsEntryAsPasswordReset - passwordQuestion |
|
|
See SettingsEntryAsBool - passwordNoResetByAdmin |
Field |
Type |
Description |
|---|---|---|
Index |
||
|
|
Optional See SettingsEntryAsBool - showIndex |
|
|
Optional See SettingsEntryAsBool - indexSpread |
|
|
Optional See SettingsEntryAsBool - indexFreeze |
|
|
Optional See SettingsEntryAsSortIndex - indexSortby |
Field |
Type |
Description |
|---|---|---|
User |
||
|
|
See SettingsEntryAsBool - markseen |
|
|
See SettingsEntryAsBool - editRights |
|
|
See SettingsEntryAsBool - showBin |
|
|
See SettingsEntryAsBool - showAdmins |
|
|
See SettingsEntryAsDefaultVisibility - doesNotSeeOthersGlobal |
|
|
See SettingsEntryAsBool - userToUserMailDelivery |
|
|
See SettingsEntryAsBool - plainTextEmails |
|
|
See SettingsEntryAsBool - emailSenderCopy |
|
|
See SettingsEntryAsBool - informObserverAboutInvite |
|
|
See SettingsEntryAsSendInformationEmails - NF_InformResponsibleOnly |
|
|
See SettingsEntryAsBool - showWelcome |
|
|
Optional. See SettingsEntryAsBool - defineUsernames |
|
|
Optional. See SettingsEntryAsInviteValidDays - inviteValidDuration |
Field |
Type |
Description |
|---|---|---|
Functions |
||
|
|
Optional. See SettingsEntryAsBool - managedFileTransfer |
|
|
Optional. See SettingsEntryAsBool - managedFileTransferUpload |
|
|
Optional. See SettingsEntryAsBool - managedFileTransferPassword |
|
|
Optional. See SettingsEntryAsBool - ipad |
|
|
Optional. See SettingsEntryAsBool - webdav |
|
|
Optional. See SettingsEntryAsBool - sftp |
|
|
Optional. See SettingsEntryAsBool - showVideoConference |
|
|
Optional. See SettingsEntryAsBool - showMeetings |
|
|
Optional. See SettingsEntryAsBool - showVotings |
|
|
Optional. See SettingsEntryAsBool - showFavourites |
|
|
Optional. See SettingsEntryAsBool - showNewFiles |
|
|
Optional. See SettingsEntryAsBool - showLocked |
|
|
Optional. See SettingsEntryAsBool - showRecentComments |
|
|
Optional. See SettingsEntryAsBool - showPrefered |
|
|
Optional. See SettingsEntryAsBool - showComments |
|
|
Optional. See SettingsEntryAsCommentVisibility - showCommentsScope |
Field |
Type |
Description |
|---|---|---|
Disclaimer |
||
|
|
Optional. See SettingsEntryAsBool - showDisclaimer |
|
|
Optional. See SettingsEntryAsBool - disclaimerReAccept |
|
|
Optional. See SettingsEntryAsBool - disclaimerReAccept |
Field |
Type |
Description |
|---|---|---|
UI |
||
|
|
|
|
|
Optional. See SettingsEntryAsBool |
|
|
|
|
|
|
Field |
Type |
Description |
|---|---|---|
Additional |
||
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsAccentColor |
|
|
Optional. |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
Field |
Type |
Description |
|---|---|---|
Send |
||
|
|
Optional. See SettingsEntryAsString |
|
|
Optional. See SettingsEntryAsDate |
Field |
Type |
Description |
|---|---|---|
Dealroom |
||
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsInformOnStatusChange |
|
|
Optional. See SettingsEntryAsDealroomStatus |
|
|
Optional. See DealroomStatusHistory |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsNumber |
|
|
Optional. See SettingsEntryAsNumber |
Field |
Type |
Description |
|---|---|---|
MS-Teams-Integration |
||
|
|
Optional. See SettingsEntryAsBool |
Allow machine machine translation using DeepL |
||
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsNumber |
Redaction |
||
|
|
Optional. See SettingsEntryAsBool - createViewerRedactions: standard redaction |
Smart Redaction |
||
|
|
Optional. See SettingsEntryAsBool - enables Smart Redaction |
|
|
Optional. See SettingsEntryAsBool |
|
|
Optional. See SettingsEntryAsString |
SettingsEntryAsUIlogo#
Settings entry for ui logo
message SettingsEntryAsUILogo {
LogoType value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
See LogoType |
|
|
Optional. |
|
|
Optional. |
|
|
Optional. |
|
|
Optional. |
|
|
Optional. |
SettingsEntryAsE2EESettings#
Settings for end2end encryption
message SettingsEntryAsE2EESettings {
string pubkey = 1;
string pkey = 2;
string pkey_backup = 3;
string e2ee_user_key = 4;
bool editable = 5;
optional string field_type = 6;
optional string tooltip_type = 7;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Optional. |
|
|
Optional. |
DrInfoEntry#
Defines one info entry for a data room
message DrInfoEntry {
string title = 1;
string id = 2;
bool is_confirmed = 3;
bool is_invited = 4;
bool two_factor_enabled = 43;
bool is_admin = 5;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DrInfo#
Infos about data rooms of a user
message DrInfo {
repeated DrInfoEntry entries = 1;
}
Field |
Type |
Description |
|---|---|---|
|
|
See DrInfoEntry |
SettingsEntryAsDrInfo#
Settings for data room info
message SettingsEntryAsDrInfo {
repeated DrInfoEntry value = 1;
bool editable = 2;
}
Field |
Type |
Description |
|---|---|---|
|
array of |
See DrInfoEntry |
|
|
EpEmailVerificationInfo#
Defines if user is external or needs email verification
- message EpEmailVerificationInfo {
bool needs_verification = 1; bool is_external = 2; // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ optional google.protobuf.Timestamp verification_date = 43;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
Optional. - ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/ |
SettingsEntryAsEpEmailVerificationInfo#
Settings for email verification
message SettingsEntryAsEpEmailVerificationInfo {
EpEmailVerificationInfo value = 1;
bool editable = 2;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
GroupTypeInfo#
Defines the group type information.
message GroupTypeInfo {
string id = 1;
string title = 2;
SystemType system_type = 3;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
See SystemType |
UserSettings#
Settings for a single user
message UserSettings {
string id = 1;
SettingsEntryAsString username = 2;
SettingsEntryAsString real_name = 3;
SettingsEntryAsLanguage language = 4;
SettingsEntryAsUserNotification notification = 5;
optional SettingsEntryAsBool show_welcome_dialog = 6;
optional SettingsEntryAsTwoFactorType two_factor_type = 7;
optional SettingsEntryAsThemeMode theme_mode = 8;
optional SettingsEntryAsBool use_ms_office = 9;
optional SettingsEntryAsBool receive_info_mails = 10;
optional SettingsEntryAsBool use_managed_filetransfer = 11;
optional SettingsEntryAsBool create_video_conferences = 12;
optional SettingsEntryAsDate restrict_access_from = 13;
optional SettingsEntryAsDate restrict_access_to = 14;
optional SettingsEntryAsBool use_sftp = 15;
optional SettingsEntryAsBool unpack_archives_on_upload = 16;
SettingsEntryAsString first_name = 17;
SettingsEntryAsString last_name = 18;
SettingsEntryAsString email = 19;
SettingsEntryAsSalutation salutation = 20;
SettingsEntryAsString title = 21;
SettingsEntryAsString mobile_phone_nr = 22;
SettingsEntryAsString website = 24;
SettingsEntryAsString company = 23;
UserSettingsEntryAsAddress address = 25;
SettingsEntryAsString department = 26;
SettingsEntryAsString position = 27;
SettingsEntryAsString phone_nr = 28;
SettingsEntryAsString fax_nr = 29;
optional SettingsEntryAsBool use_webdav = 30;
optional SettingsEntryAsBool use_tablet_app = 31;
optional SettingsEntryAsString mountpoint = 32;
optional SettingsEntryAsBool use_private_folder = 33;
optional UserSettingsEntryAsPrivateLabel labels = 34;
optional SettingsEntryAsBool download_protected_pdf = 35;
optional SettingsEntryAsBool print_protected_pdf = 36;
optional UserSettingsEntryAsSignature signature = 37;
optional UserSettingsEntryAsUserFeatures user_features = 38;
optional SettingsEntryAsBool two_factor_enabled = 39;
optional SettingsEntryAsBool has_photo = 40;
optional SettingsEntryAsDefaultVisibility visibility = 41;
optional SettingsEntryAsNumber logins = 42;
optional SettingsEntryAsDate last_login = 43;
optional SettingsEntryAsDate created = 44;
optional UserSettingsEntryAsGroupMembership groups = 45;
optional UserSettingsEntryAsUserGroupMembership user_groups = 61;
optional SettingsEntryAsDate invitation_sent = 46;
optional SettingsEntryAsBool access_contract_data = 47;
optional SettingsEntryAsString single_sign_on_id = 48;
optional SettingsEntryAsBool single_sign_on_enabled = 49;
optional SettingsEntryAsBool newsletter = 50;
optional SettingsEntryAsString end_customer_id = 51;
optional SettingsEntryAsBool send_invitation_later = 52;
optional SettingsEntryAsBool send_invitation_to_me_only = 53;
optional SettingsEntryAsString user_activation_observer_email = 54;
optional SettingsEntryAsString cost_center = 55;
optional SettingsEntryAsString message_to_new_user = 56;
optional SettingsEntryAsString timezone = 57;
optional SettingsEntryAsLocale locale = 58;
optional SettingsEntryAsString user_title = 59;
// protolint:disable:next MAX_LINE_LENGTH
optional SettingsEntryAsManagedFiletransferVisibility managed_filetransfer_visibility = 60;
optional bool has_shared_secret = 62;
optional bool has_exports = 63;
optional SettingsEntryAsString pkey = 64;
optional SettingsEntryAsString pubkey = 65;
optional SettingsEntryAsString pkey_backup = 66;
optional SettingsEntryAsString e2ee_user_key = 67;
optional SettingsEntryAsAccentColor accent_color = 68;
optional SettingsEntryAsBool ep_admin_has_limited_rights = 69;
optional SettingsEntryAsBool is_user_inactive = 70;
optional SettingsEntryAsBool ep_admin_can_access_contract_data = 71;
optional SettingsEntryAsDrInfo dataroom_info = 72;
optional SettingsEntryAsEpEmailVerificationInfo email_verification_info = 73;
optional SettingsEntryAsBool mention_notifications = 74;
// Send settings
optional SettingsEntryAsNumber send_sent_ttl_days = 80;
optional SettingsEntryAsBool send_sent_notifications = 81;
optional SettingsEntryAsSendAuthenticationType send_sent_auth = 82;
optional SettingsEntryAsNumber send_received_ttl_days = 83;
optional SettingsEntryAsBool send_received_notifications = 84;
optional SettingsEntryAsSendAuthenticationType send_received_auth = 85;
optional SettingsEntryAsSendAutoDeleteType send_auto_delete_type = 86;
optional SettingsEntryAsNumber send_auto_delete_days = 87;
optional SettingsEntryAsRootQuota send_root_quota_used = 88;
optional SettingsEntryAsBool show_folder_on_top = 100; // folderFirst
optional SettingsEntryAsBool show_time_created = 101; // showTimeCreated
optional SettingsEntryAsBool show_date_with_time = 102; // showDateWithTime
optional SettingsEntryAsBool show_version_author = 103; // showAuthor
optional SettingsEntryAsBool show_permissions_icon = 104; // showRightsIcon
optional SettingsEntryAsListView list_view = 105;
optional SettingsEntryAsNumber group_permissions_mask = 106;
//optional SettingsEntryAsString group_type_id = 107;
optional GroupTypeInfo group_type_info = 108;
optional SettingsEntryAsBool single_sign_on_verification_required = 109;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsTwoFactorType |
|
|
Optional See SettingsEntryAsThemeMode |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsDate |
|
|
Optional See SettingsEntryAsDate |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See UserSettingsEntryAsPrivateLabel |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See UserSettingsEntryAsSignature |
|
|
Optional See UserSettingsEntryAsUserFeatures |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsDefaultVisibility |
|
|
Optional See SettingsEntryAsNumber |
|
|
Optional See SettingsEntryAsDate |
|
|
Optional See SettingsEntryAsDate |
|
|
Optional See UserSettingsEntryAsGroupMembership |
|
|
Optional See UserSettingsEntryAsUserGroupMembership |
|
|
Optional See SettingsEntryAsDate |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsLocale |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsManagedFiletransferVisibility |
|
|
Optional |
|
|
Optional |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsString |
|
|
Optional See SettingsEntryAsAccentColor |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsDrInfo |
|
|
Optional See SettingsEntryAsEpEmailVerificationInfo |
|
|
Optional See SettingsEntryAsBool |
Send settings |
||
|
|
Optional See SettingsEntryAsNumber |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsSendAuthenticationType |
|
|
Optional See SettingsEntryAsNumber |
|
|
Optional See SettingsEntryAsBool |
|
|
Optional See SettingsEntryAsSendAuthenticationType |
|
|
Optional See SettingsEntryAsSendAutoDeleteType |
|
|
Optional See SettingsEntryAsNumber |
|
|
Optional See SettingsEntryAsRootQuota |
|
|
Optional See SettingsEntryAsBool - folderFirst |
|
|
Optional See SettingsEntryAsBool - showTimeCreated |
|
|
Optional See SettingsEntryAsBool - showDateWithTime |
|
|
Optional See SettingsEntryAsBool - showAuthor |
|
|
Optional See SettingsEntryAsBool - showRightsIcon |
|
|
Optional See SettingsEntryAsListView |
|
|
Optional See SettingsEntryAsNumber |
|
|
Optional See SettingsEntryAsString – Commented out |
|
|
Optional See GroupTypeInfo |
|
|
Optional See SettingsEntryAsBool |
UserFeatures#
A list of features a user can select for the left frame
message UserFeatures {
optional bool favorites = 1;
optional bool new_files = 2;
optional bool preferred_files = 3;
optional bool locked_files = 4;
optional bool recent_comments = 5;
optional bool expired_files = 6;
optional bool unread_files = 7;
optional bool labels = 8;
optional bool tobeapproved_files = 9;
optional bool inbox = 10;
optional bool outbox = 11;
optional bool videoconferences = 14;
}
Field |
Type |
Description |
|---|---|---|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
UserSignature#
The users signature for emails
message UserSignature {
bool signature_enabled = 1;
bool signature_from_personal_data = 2;
string signature = 3;
string personal_signature = 4;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
UserAddress#
The users address information DEPRECATED!!
message UserAddress {
string country = 1;
string city = 2;
string zip_code = 3;
string street = 4;
}
PrivateLabel#
The users private labels
message PrivateLabel {
PrivateLabelEntry label1 = 1;
PrivateLabelEntry label2 = 2;
PrivateLabelEntry label3 = 3;
PrivateLabelEntry label4 = 4;
PrivateLabelEntry label5 = 5;
PrivateLabelEntry label6 = 6;
PrivateLabelEntry label7 = 7;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
PrivateLabelEntry#
One entry of private lobel
message PrivateLabelEntry {
string text = 1;
bool enabled = 2;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
UserSettingsEntryAsPrivateLabel#
The label with extended information
message UserSettingsEntryAsPrivateLabel {
PrivateLabel value = 1;
bool editable = 2;
}
Field |
Type |
Description |
|---|---|---|
|
|
See PrivateLabel |
|
|
UserSettingsEntryAsAddress#
The user address with extended information
message UserSettingsEntryAsAddress {
UserAddress value = 1;
bool editable = 2;
}
Field |
Type |
Description |
|---|---|---|
|
|
See UserAddress |
|
|
UserSettingsEntryAsSignature#
The user signature with extended information
message UserSettingsEntryAsSignature {
UserSignature value = 1;
bool editable = 2;
}
Field |
Type |
Description |
|---|---|---|
|
|
See UserSignature |
|
|
SettingsEntryAsString#
One user setting with value as string. The attribute editable indicates if the field can be changed. The attribute available indicates, if the field should be shown in the data room settings dialog. The attribute admin_editable is used in combination with enterprise templates.
message SettingsEntryAsString {
string value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsBool#
One user setting with value as bool
message SettingsEntryAsBool {
optional bool value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsNumber#
One user setting with value as bool
message SettingsEntryAsNumber {
uint64 value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
SettingsEntryAsDate#
One user setting with value as date
message SettingsEntryAsDate {
google.protobuf.Timestamp value = 1;
optional bool editable = 2;
optional string field_type = 3;
optional string tooltip_type = 4;
optional bool available = 5;
optional bool admin_editable = 6;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
|
|
Optional |
UserSettingsEntryAsUserFeatures#
One user setting with value as date
message UserSettingsEntryAsUserFeatures {
UserFeatures value = 1;
bool editable = 2;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
UserSettingsEntryAsGroupMembership#
Group membership of user (deprecated)
message UserSettingsEntryAsGroupMembership {
// All UserSettingsEntry need a .value
// protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
repeated string value = 1;
bool editable = 2;
}
UserMembershipGroup#
One entry for group membership of user
message UserMembershipGroup {
string id = 1;
string title = 2;
string name = 3;
}
Field |
Type |
Description |
|---|---|---|
|
|
|
|
|
|
|
|
UserSettingsEntryAsUserGroupMembership#
Group membership of user
message UserSettingsEntryAsUserGroupMembership {
// protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
repeated UserMembershipGroup value = 1;
bool editable = 2;
}
Field |
Type |
Description |
|---|---|---|
|
array of |
|
|
|