Settings

Contents

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

default_name

string

Optional

company_name

string

Optional

name

string

Optional

type

EmailSenderCompanyType

See EmailSenderCompanyType

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

value

ListView

See ListView

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

EmailSenderCompany

See EmailSenderCompany

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

EmptyTrashBin

See EmptyTrashBin

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

HideExpiredDocuments

See HideExpiredDocuments

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

DownloadListFormat

See DownloadListFormat

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

AutoLogOff

See AutoLogOff

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

LoginVerification

See LoginVerification

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

PasswordMinLength

See PasswordMinLength

editable

bool

Optional

field_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

PasswordChangeInterval

See PasswordChangeInterval

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

PasswordResetOption

See PasswordResetOption

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

SortIndexOption

See SortIndexOption

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

DefaultVisibilityOption

See DefaultVisibilityOption

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

SendInformationEmailsOption

See SendInformationEmailsOption

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

CommentVisibilityOption

See CommentVisibilityOption

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

ThemeMode

See ThemeMode

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

AccentColor

See AccentColor

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

UserNotification

See UserNotification

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

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

value

TwoFactorType

See TwoFactorType

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

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

value

Salutation

See Salutation

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

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

value

Language

See Language

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

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

value

Locale

See Locale

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

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

value

EncryptionType

See EncryptionType

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

ManagedFiletransferVisibility

See ManagedFiletransferVisibility

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

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

value

InviteValidDays

See InviteValidDays

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

horizontal

WatermarkLayoutHorizontalPosition

Optional. See WatermarkLayoutHorizontalPosition

vertical

WatermarkLayoutVerticalPosition

Optional. See WatermarkLayoutVerticalPosition

rotation

WatermarkLayoutRotation

Optional. See WatermarkLayoutRotation

type

WatermarkLayoutPositionType

See WatermarkLayoutPositionType

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

user_name

bool

Optional

user_email

bool

Optional

dataroom_name

bool

Optional

date

bool

Optional

custom_text

string

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

font

string

Optional

font_size

uint32

Optional

font_weight

string

Optional

color

string

Optional

opacity

float

Optional

text

WatermarkLayoutText

Optional See:ref:WatermarkLayoutText <WatermarkLayoutText>

position

WatermarkLayoutPosition

Optional See:ref:WatermarkLayoutPosition <WatermarkLayoutPosition>

WatermarkLayouts#

Array of different layouts

message WatermarkLayouts {
 repeated WatermarkLayout layouts = 1;
}

Field

Type

Description

layouts

WatermarkLayout

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

value

WatermarkLayouts

See :ref: WatermarkLayouts <WatermarkLayouts>

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

ActivityLogStoragePeriod

See :ref: ActivityLogStoragePeriod <ActivityLogStoragePeriod>

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

SendAuthenticationType

See :ref: SendAuthenticationType <SendAuthenticationType>

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

SendAutoDeleteType

See :ref: SendAutoDeleteType <SendAutoDeleteType>

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

Optional

RootQuota#

message RootQuota {
 ItemType root_type = 1;
 uint64 used_size = 2;
}

Field

Type

Description

root_type

ItemType

See :ref: ItemType <ItemType>

used_size

uint64

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

value

array of RootQuota

See :ref: RootQuota <RootQuota>

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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 = 1

  • color = 2

  • enabled = 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

text

string

color

string

enabled

bool

not_editable

uint32

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

states

map<string, DocumentStateDefinitionEntry>

See DocumentStateDefinitionEntry

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

value

DocumentStateDefinitions

See DocumentStateDefinitions

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

title

string

id

string

invite

bool

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

users

array of InformOnOpenUser

See InformOnOpenUser

inform_admins

bool

Optional

inform_sell_side

bool

Optional

inform_all_users

bool

Optional

message_on_invite

string

Optional

create_backup

bool

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

value

InformOnStatusChange

See InformOnStatusChange

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

DealroomStatus

See DealroomStatus

editable

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

creation_date

google.protobuf.Timestamp

ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/

execution_user

string

transition

DealroomStatusTransition

See DealroomStatusTransition

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

value

array of DealroomStatusHistoryEntry

See DealroomStatusHistoryEntry

editable

bool

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

dataroom_id

string

Optional

last_changed

google.protobuf.Timestamp

Optional

General

dataroom_name

SettingsEntryAsString

See SettingsEntryAsString

show_number_of_documents

SettingsEntryAsBool

See SettingsEntryAsBool - showCOllectionSize

download_list_format

SettingsEntryAsDownloadListFormat

See SettingsEntryAsDownloadListFormat

log_activity_recursive

SettingsEntryAsBool

See SettingsEntryAsBool -activityLogRecursive

NF_NotifyEmailSenderCompany

email_sender_name

SettingsEntryAsEmailSenderCompany

See SettingsEntryAsEmailSenderCompany

activity_log_storage_period

SettingsEntryAsActivityLogStoragePeriod

Optional. See SettingsEntryAsActivityLogStoragePeriod

Documents

require_document_approval

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - useApproval

notify_about_changes

SettingsEntryAsBool

See SettingsEntryAsBool - allowAgents

notify_about_changes_for_unconfirmed_users

SettingsEntryAsBool

See SettingsEntryAsBool - allowAgentsUnConfirmed

use_version_control

SettingsEntryAsBool

See SettingsEntryAsBool - versionControl

use_group_labels

SettingsEntryAsBool

See SettingsEntryAsBool - useGroupLabels

create_office_documents

SettingsEntryAsBool

See SettingsEntryAsBool - openOfficeDocuments

show_office_documents_navigable

SettingsEntryAsBool

See SettingsEntryAsBool - showOfficeInCollabora

create_text_documents

SettingsEntryAsBool

See SettingsEntryAsBool - showDocuments

download_instead_open

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - defaultDownload

download_zip

SettingsEntryAsBool

See SettingsEntryAsBool - defaultZipDownloads

allow_folder_download

SettingsEntryAsBool

See SettingsEntryAsBool - canDownloadFolderOption

use_fulltext_search

SettingsEntryAsBool

See SettingsEntryAsBool - createFulltextIndex

create_document_annotations

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - createViewerAnnotations

create_shared_document_annotations

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - createViewerSharedAnnotations

show_permissions_icon

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showRightsIcon

download_user_may_see_version_history

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

days_expired_documents_hidden

SettingsEntryAsHideExpired

Optional. See SettingsEntryAsHideExpired - docLivetime

days_empty_trash

SettingsEntryAsTrashBin

See SettingsEntryAsTrashBin - emptyTrashDays

use_private_labels

SettingsEntryAsBool

See SettingsEntryAsBool - useLabels

document_states

SettingsEntryAsDocumentStateDefinitions

Optional. See SettingsEntryAsDocumentStateDefinitions

enable_document_states

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

Security

show_login_activity

SettingsEntryAsBool

See SettingsEntryAsBool

send_email_for_new_devices

SettingsEntryAsBool

See SettingsEntryAsBool - showDeviceAccess

auto_logoff

SettingsEntryAsAutoLogOff

See SettingsEntryAsAutoLogOff - newlogoutSecs

login_verification

SettingsEntryAsLoginVerification

See SettingsEntryAsLoginVerification - device_access_type

exclude_ip_range

SettingsEntryAsString

See SettingsEntryAsString - ipaddress

scan_for_virus

SettingsEntryAsBool

See SettingsEntryAsBool - virusScan

encrypt_files

SettingsEntryAsBool

See SettingsEntryAsBool - encryptFiles

e2ee

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

use_permission_read_only

SettingsEntryAsBool

See SettingsEntryAsBool - prohibitDownload

use_permission_download_pdf

SettingsEntryAsBool

See SettingsEntryAsBool - allowPdfDownload

use_watermarks_pdf

SettingsEntryAsBool

See SettingsEntryAsBool - useWatermarks

watermark_layouts

SettingsEntryAsWatermarkLayouts

Optional. See SettingsEntryAsWatermarkLayouts

download_pdfs_encrypted

SettingsEntryAsBool

See SettingsEntryAsBool - downloadentryptedpdf

Password

password_min_length

SettingsEntryAsPasswordMinLength

See SettingsEntryAsPasswordMinLength - passwordMinChars

password_requires_special_chars

SettingsEntryAsBool

See SettingsEntryAsBool - passwordUseSpecial

password_requires_numbers

SettingsEntryAsBool

See SettingsEntryAsBool - passwordUseNumbers

password_requires_mixed_letters

SettingsEntryAsBool

See SettingsEntryAsBool - passwordUseMixed

password_change_interval

SettingsEntryAsPasswordChange

See SettingsEntryAsPasswordChange - passwordChangeInt

password_reset

SettingsEntryAsPasswordReset

See SettingsEntryAsPasswordReset - passwordQuestion

password_reset_by_admin

SettingsEntryAsBool

See SettingsEntryAsBool - passwordNoResetByAdmin

Field

Type

Description

Index

use_file_index

SettingsEntryAsBool

Optional See SettingsEntryAsBool - showIndex

spread_upload_by_index

SettingsEntryAsBool

Optional See SettingsEntryAsBool - indexSpread

freeze_index

SettingsEntryAsBool

Optional See SettingsEntryAsBool - indexFreeze

sort_index

SettingsEntryAsSortIndex

Optional See SettingsEntryAsSortIndex - indexSortby

Field

Type

Description

User

mark_unseen_documents

SettingsEntryAsBool

See SettingsEntryAsBool - markseen

user_may_change_rights

SettingsEntryAsBool

See SettingsEntryAsBool - editRights

user_may_trash_files

SettingsEntryAsBool

See SettingsEntryAsBool - showBin

show_admin_group

SettingsEntryAsBool

See SettingsEntryAsBool - showAdmins

default_visibility

SettingsEntryAsDefaultVisibility

See SettingsEntryAsDefaultVisibility - doesNotSeeOthersGlobal

allow_emails_to_users

SettingsEntryAsBool

See SettingsEntryAsBool - userToUserMailDelivery

allow_emails_as_plaintext_only

SettingsEntryAsBool

See SettingsEntryAsBool - plainTextEmails

require_emails_copy_to_sender

SettingsEntryAsBool

See SettingsEntryAsBool - emailSenderCopy

send_observer_email_on_invite

SettingsEntryAsBool

See SettingsEntryAsBool - informObserverAboutInvite

send_information_emails

SettingsEntryAsSendInformationEmails

See SettingsEntryAsSendInformationEmails - NF_InformResponsibleOnly

show_introduction_dialog

SettingsEntryAsBool

See SettingsEntryAsBool - showWelcome

define_usernames_enabled

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - defineUsernames

invite_valid_days

SettingsEntryAsInviteValidDays

Optional. See SettingsEntryAsInviteValidDays - inviteValidDuration

Field

Type

Description

Functions

use_managed_filetransfer

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - managedFileTransfer

use_managed_filetransfer_local_upload

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - managedFileTransferUpload

use_managed_filetransfer_password

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - managedFileTransferPassword

use_tablet_app

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - ipad

use_webdav

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - webdav

use_sftp

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - sftp

use_video_conferences

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showVideoConference

use_meetings

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showMeetings

use_votings

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showVotings

show_favorites

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showFavourites

show_new_files

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showNewFiles

show_locked_files

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showLocked

show_recent_comments

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showRecentComments

show_preferred_files

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showPrefered

use_comments

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showComments

comment_visibility

SettingsEntryAsCommentVisibility

Optional. See SettingsEntryAsCommentVisibility - showCommentsScope

Field

Type

Description

Disclaimer

use_disclaimer

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - showDisclaimer

reaccept_disclaimer

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - disclaimerReAccept

disclaimer_text

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - disclaimerReAccept

Field

Type

Description

UI

dataroom_logo

SettingsEntryAsUILogo

See SettingsEntryAsUILogo

on_upload_scale_only

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

color_scheme

SettingsEntryAsThemeMode

See SettingsEntryAsThemeMode

login_page_url

SettingsEntryAsString

See SettingsEntryAsString

Field

Type

Description

Additional

show_password_directive

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

allow_export_dataroom

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

allow_import_users

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

allow_time_restricted_access

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

show_dataroom_index

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

show_user_activities

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

allow_invitation_send_later

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

allow_invitation_send_as_link

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

show_dataroom_settings

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

accent_color

SettingsEntryAsAccentColor

Optional. See SettingsEntryAsAccentColor

dataroom_logo_name

string

Optional.

enable_co_editing

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

show_folder_activities

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

allow_custom_watermarks

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

Field

Type

Description

Send

denylisted_email_domains

SettingsEntryAsString

Optional. See SettingsEntryAsString

contract_end

SettingsEntryAsDate

Optional. See SettingsEntryAsDate

Field

Type

Description

Dealroom

use_qa_comments

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

use_multi_group_membership

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

inform_on_status_change

SettingsEntryAsInformOnStatusChange

Optional. See SettingsEntryAsInformOnStatusChange

dealroom_status

SettingsEntryAsDealroomStatus

Optional. See SettingsEntryAsDealroomStatus

dealroom_status_history

DealroomStatusHistory

Optional. See DealroomStatusHistory

use_dr_comments

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

allowed_permissions_buy

SettingsEntryAsNumber

Optional. See SettingsEntryAsNumber

allowed_permissions_sell

SettingsEntryAsNumber

Optional. See SettingsEntryAsNumber

Field

Type

Description

MS-Teams-Integration

use_ms_teams

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

Allow machine machine translation using DeepL

allow_machine_translation

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

total_deep_l_used_characters

SettingsEntryAsNumber

Optional. See SettingsEntryAsNumber

Redaction

create_document_redactions

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - createViewerRedactions: standard redaction

Smart Redaction

enable_smart_redaction

SettingsEntryAsBool

Optional. See SettingsEntryAsBool - enables Smart Redaction

smart_redact_new_files

SettingsEntryAsBool

Optional. See SettingsEntryAsBool

smart_redaction_configuration

SettingsEntryAsString

Optional. See SettingsEntryAsString

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

pubkey

string

pkey

string

pkey_backup

string

e2ee_user_key

string

editable

bool

field_type

string

Optional.

tooltip_type

string

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

title

string

id

string

is_confirmed

bool

is_invited

bool

two_factor_enabled

bool

is_admin

bool

DrInfo#

Infos about data rooms of a user

message DrInfo {
 repeated DrInfoEntry entries = 1;
}

Field

Type

Description

entries

DrInfoEntry

See DrInfoEntry

SettingsEntryAsDrInfo#

Settings for data room info

message SettingsEntryAsDrInfo {
 repeated DrInfoEntry value = 1;
 bool editable = 2;
}

Field

Type

Description

value

array of DrInfoEntry

See DrInfoEntry

editable

bool

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

needs_verification

bool

is_external

bool

verification_date

google.protobuf.Timestamp

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

value

EpEmailVerificationInfo

See EpEmailVerificationInfo

editable

bool

GroupTypeInfo#

Defines the group type information.

message GroupTypeInfo {
 string id = 1;
 string title = 2;
 SystemType system_type = 3;
}

Field

Type

Description

id

string

title

string

system_type

SystemType

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

id

string

username

SettingsEntryAsString

See SettingsEntryAsString

real_name

SettingsEntryAsString

See SettingsEntryAsString

language

SettingsEntryAsLanguage

See SettingsEntryAsLanguage

notification

SettingsEntryAsUserNotification

See SettingsEntryAsUserNotification

show_welcome_dialog

SettingsEntryAsBool

Optional See SettingsEntryAsBool

two_factor_type

SettingsEntryAsTwoFactorType

Optional See SettingsEntryAsTwoFactorType

theme_mode

SettingsEntryAsThemeMode

Optional See SettingsEntryAsThemeMode

use_ms_office

SettingsEntryAsBool

Optional See SettingsEntryAsBool

receive_info_mails

SettingsEntryAsBool

Optional See SettingsEntryAsBool

use_managed_filetransfer

SettingsEntryAsBool

Optional See SettingsEntryAsBool

create_video_conferences

SettingsEntryAsBool

Optional See SettingsEntryAsBool

restrict_access_from

SettingsEntryAsDate

Optional See SettingsEntryAsDate

restrict_access_to

SettingsEntryAsDate

Optional See SettingsEntryAsDate

use_sftp

SettingsEntryAsBool

Optional See SettingsEntryAsBool

unpack_archives_on_upload

SettingsEntryAsBool

Optional See SettingsEntryAsBool

first_name

SettingsEntryAsString

See SettingsEntryAsString

last_name

SettingsEntryAsString

See SettingsEntryAsString

email

SettingsEntryAsString

See SettingsEntryAsString

salutation

SettingsEntryAsSalutation

See SettingsEntryAsSalutation

title

SettingsEntryAsString

See SettingsEntryAsString

mobile_phone_nr

SettingsEntryAsString

See SettingsEntryAsString

website

SettingsEntryAsString

See SettingsEntryAsString

company

SettingsEntryAsString

See SettingsEntryAsString

address

UserSettingsEntryAsAddress

See UserSettingsEntryAsAddress

department

SettingsEntryAsString

See SettingsEntryAsString

position

SettingsEntryAsString

See SettingsEntryAsString

phone_nr

SettingsEntryAsString

See SettingsEntryAsString

fax_nr

SettingsEntryAsString

See SettingsEntryAsString

use_webdav

SettingsEntryAsBool

Optional See SettingsEntryAsBool

use_tablet_app

SettingsEntryAsBool

Optional See SettingsEntryAsBool

mountpoint

SettingsEntryAsString

Optional See SettingsEntryAsString

use_private_folder

SettingsEntryAsBool

Optional See SettingsEntryAsBool

labels

UserSettingsEntryAsPrivateLabel

Optional See UserSettingsEntryAsPrivateLabel

download_protected_pdf

SettingsEntryAsBool

Optional See SettingsEntryAsBool

print_protected_pdf

SettingsEntryAsBool

Optional See SettingsEntryAsBool

signature

UserSettingsEntryAsSignature

Optional See UserSettingsEntryAsSignature

user_features

UserSettingsEntryAsUserFeatures

Optional See UserSettingsEntryAsUserFeatures

two_factor_enabled

SettingsEntryAsBool

Optional See SettingsEntryAsBool

has_photo

SettingsEntryAsBool

Optional See SettingsEntryAsBool

visibility

SettingsEntryAsDefaultVisibility

Optional See SettingsEntryAsDefaultVisibility

logins

SettingsEntryAsNumber

Optional See SettingsEntryAsNumber

last_login

SettingsEntryAsDate

Optional See SettingsEntryAsDate

created

SettingsEntryAsDate

Optional See SettingsEntryAsDate

groups

UserSettingsEntryAsGroupMembership

Optional See UserSettingsEntryAsGroupMembership

user_groups

UserSettingsEntryAsUserGroupMembership

Optional See UserSettingsEntryAsUserGroupMembership

invitation_sent

SettingsEntryAsDate

Optional See SettingsEntryAsDate

access_contract_data

SettingsEntryAsBool

Optional See SettingsEntryAsBool

single_sign_on_id

SettingsEntryAsString

Optional See SettingsEntryAsString

single_sign_on_enabled

SettingsEntryAsBool

Optional See SettingsEntryAsBool

newsletter

SettingsEntryAsBool

Optional See SettingsEntryAsBool

end_customer_id

SettingsEntryAsString

Optional See SettingsEntryAsString

send_invitation_later

SettingsEntryAsBool

Optional See SettingsEntryAsBool

send_invitation_to_me_only

SettingsEntryAsBool

Optional See SettingsEntryAsBool

user_activation_observer_email

SettingsEntryAsString

Optional See SettingsEntryAsString

cost_center

SettingsEntryAsString

Optional See SettingsEntryAsString

message_to_new_user

SettingsEntryAsString

Optional See SettingsEntryAsString

timezone

SettingsEntryAsString

Optional See SettingsEntryAsString

locale

SettingsEntryAsLocale

Optional See SettingsEntryAsLocale

user_title

SettingsEntryAsString

Optional See SettingsEntryAsString

managed_filetransfer_visibility

SettingsEntryAsManagedFiletransferVisibility

Optional See SettingsEntryAsManagedFiletransferVisibility

has_shared_secret

bool

Optional

has_exports

bool

Optional

pkey

SettingsEntryAsString

Optional See SettingsEntryAsString

pubkey

SettingsEntryAsString

Optional See SettingsEntryAsString

pkey_backup

SettingsEntryAsString

Optional See SettingsEntryAsString

e2ee_user_key

SettingsEntryAsString

Optional See SettingsEntryAsString

accent_color

SettingsEntryAsAccentColor

Optional See SettingsEntryAsAccentColor

ep_admin_has_limited_rights

SettingsEntryAsBool

Optional See SettingsEntryAsBool

is_user_inactive

SettingsEntryAsBool

Optional See SettingsEntryAsBool

ep_admin_can_access_contract_data

SettingsEntryAsBool

Optional See SettingsEntryAsBool

dataroom_info

SettingsEntryAsDrInfo

Optional See SettingsEntryAsDrInfo

email_verification_info

SettingsEntryAsEpEmailVerificationInfo

Optional See SettingsEntryAsEpEmailVerificationInfo

mention_notifications

SettingsEntryAsBool

Optional See SettingsEntryAsBool

Send settings

send_sent_ttl_days

SettingsEntryAsNumber

Optional See SettingsEntryAsNumber

send_sent_notifications

SettingsEntryAsBool

Optional See SettingsEntryAsBool

send_sent_auth

SettingsEntryAsSendAuthenticationType

Optional See SettingsEntryAsSendAuthenticationType

send_received_ttl_days

SettingsEntryAsNumber

Optional See SettingsEntryAsNumber

send_received_notifications

SettingsEntryAsBool

Optional See SettingsEntryAsBool

send_received_auth

SettingsEntryAsSendAuthenticationType

Optional See SettingsEntryAsSendAuthenticationType

send_auto_delete_type

SettingsEntryAsSendAutoDeleteType

Optional See SettingsEntryAsSendAutoDeleteType

send_auto_delete_days

SettingsEntryAsNumber

Optional See SettingsEntryAsNumber

send_root_quota_used

SettingsEntryAsRootQuota

Optional See SettingsEntryAsRootQuota

show_folder_on_top

SettingsEntryAsBool

Optional See SettingsEntryAsBool - folderFirst

show_time_created

SettingsEntryAsBool

Optional See SettingsEntryAsBool - showTimeCreated

show_date_with_time

SettingsEntryAsBool

Optional See SettingsEntryAsBool - showDateWithTime

show_version_author

SettingsEntryAsBool

Optional See SettingsEntryAsBool - showAuthor

show_permissions_icon

SettingsEntryAsBool

Optional See SettingsEntryAsBool - showRightsIcon

list_view

SettingsEntryAsListView

Optional See SettingsEntryAsListView

group_permissions_mask

SettingsEntryAsNumber

Optional See SettingsEntryAsNumber

group_type_id

SettingsEntryAsString

Optional See SettingsEntryAsString – Commented out

group_type_info

GroupTypeInfo

Optional See GroupTypeInfo

single_sign_on_verification_required

SettingsEntryAsBool

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

favorites

bool

Optional

new_files

bool

Optional

preferred_files

bool

Optional

locked_files

bool

Optional

recent_comments

bool

Optional

expired_files

bool

Optional

unread_files

bool

Optional

labels

bool

Optional

tobeapproved_files

bool

Optional

inbox

bool

Optional

outbox

bool

Optional

videoconferences

bool

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

signature_enabled

bool

signature_from_personal_data

bool

signature

string

personal_signature

string

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

label1

PrivateLabelEntry

See PrivateLabelEntry

label2

PrivateLabelEntry

See PrivateLabelEntry

label3

PrivateLabelEntry

See PrivateLabelEntry

label4

PrivateLabelEntry

See PrivateLabelEntry

label5

PrivateLabelEntry

See PrivateLabelEntry

label6

PrivateLabelEntry

See PrivateLabelEntry

label7

PrivateLabelEntry

See PrivateLabelEntry

PrivateLabelEntry#

One entry of private lobel

message PrivateLabelEntry {
 string text = 1;
 bool enabled = 2;
}

Field

Type

Description

text

string

enabled`

bool

UserSettingsEntryAsPrivateLabel#

The label with extended information

message UserSettingsEntryAsPrivateLabel {
 PrivateLabel value = 1;
 bool editable = 2;
}

Field

Type

Description

value

PrivateLabel

See PrivateLabel

editable`

bool

UserSettingsEntryAsAddress#

The user address with extended information

message UserSettingsEntryAsAddress {
 UserAddress value = 1;
 bool editable = 2;
}

Field

Type

Description

value

UserAddress

See UserAddress

editable`

bool

UserSettingsEntryAsSignature#

The user signature with extended information

message UserSettingsEntryAsSignature {
 UserSignature value = 1;
 bool editable = 2;
}

Field

Type

Description

value

UserSignature

See UserSignature

editable`

bool

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

value

string

editable`

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

bool

Optional

editable`

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

uint64

editable`

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

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

value

google.protobuf.Timestamp

editable`

bool

Optional

field_type

string

Optional

tooltip_type

string

Optional

available

bool

Optional

admin_editable

bool

Optional

UserSettingsEntryAsUserFeatures#

One user setting with value as date

message UserSettingsEntryAsUserFeatures {
 UserFeatures value = 1;
 bool editable = 2;
}

Field

Type

Description

value

UserFeatures

editable`

bool

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

id

string

title`

string

name

string

UserSettingsEntryAsUserGroupMembership#

Group membership of user

message UserSettingsEntryAsUserGroupMembership {
 // protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
 repeated UserMembershipGroup value = 1;
 bool editable = 2;
}

Field

Type

Description

value

array of UserMembershipGroup

See UserMembershipGroup

editable`

bool