Enterprise Account

SettingsEntryAsSSOInterfaceType

SSOInterfaceType as Setting

message SettingsEntryAsSsoInterfaceType {
 SsoInterfaceType value = 1;
 bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field	Type	Description
value	SsoInterfaceType
editable	bool
field_type	string	Optional
tooltip_type	string	Optional
available	bool	Optional

SettingsEntryAsInformationEmailType

InformationEmailType as Setting

message SettingsEntryAsInformationEmailType {
 InformationEmailType value = 1;
 bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field	Type	Description
value	InformationEmailType
editable	bool
field_type	string	Optional
tooltip_type	string	Optional
available	bool	Optional

SettingsEntryAsAutomaticUserCleanupType

AutomaticUserCleanupType as Setting

message SettingsEntryAsAutomaticUserCleanupType {
 AutomaticUserCleanupType value = 1;
 bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field	Type	Description
value	AutomaticUserCleanupType
editable	bool
field_type	string	Optional
tooltip_type	string	Optional
available	bool	Optional

SettingsEntryAsAutomaticUserCleanupInactivePeriod

AutomaticUserCleanupInactivePeriod as Setting

message SettingsEntryAsAutomaticUserCleanupInactivePeriod {
 AutomaticUserCleanupInactivePeriod value = 1;
 bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field	Type	Description
value	AutomaticUserCleanupInactivePeriod
editable	bool
field_type	string	Optional
tooltip_type	string	Optional
available	bool	Optional

SettingsEntryAsDataroomSettings

DataroomSettings for Template

message SettingsEntryAsDataroomSettings {
 DataroomSettings value = 1;
 bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field	Type	Description
value	DataroomSettings
editable	bool
field_type	string	Optional
tooltip_type	string	Optional
available	bool	Optional

SettingsEntryAsDataroomType

DataroomType for Template

message SettingsEntryAsDataroomType {
 DataroomType value = 1;
 bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field	Type	Description
value	DataroomType
editable	bool
field_type	string	Optional
tooltip_type	string	Optional
available	bool	Optional

SettingsEntryAsEmailVerificationPeriod

Email verification period

message SettingsEntryAsEmailVerificationPeriod {
 EmailVerificationPeriod value = 1;
 bool editable = 2;
 optional string field_type = 3;
 optional string tooltip_type = 4;
 optional bool available = 5;
}

Field	Type	Description
value	EmailVerificationPeriod
editable	bool
field_type	string	Optional
tooltip_type	string	Optional
available	bool	Optional

EnterpriseAccount

Represents one enterprise account collection

message EnterpriseAccount {
 string id = 1;
 string name = 2;
 string author = 3;
 string title = 4;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp creation_date = 6;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp modification_date = 7;
 string icon = 8;
 uint32 num_children = 9;
 ItemType item_type = 10;
 EffectivePermission effective_permission = 11;
 bool force_two_factor = 12;
 optional uint32 max_users = 13;
 optional uint32 current_users = 14;
 optional uint32 unconfirmed_users = 15;
 optional uint32 inactive_users = 16;
 optional uint32 available_users = 24;
 optional bool has_user_flatrate = 25;
 optional uint32 max_datarooms = 17;
 optional uint32 current_datarooms = 18;
 optional uint32 available_datarooms = 27;
 optional uint64 max_quantum = 19;
 optional uint64 current_quantum = 20;
 optional uint32 assigned_quantum = 21;
 optional uint32 available_quantum = 26;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp last_change_date = 22;
 optional string customer_id = 23;
 optional DataroomType enterprise_type = 28;
 optional uint64 max_file_size = 30;
 optional string responsible_username = 31;
 optional string responsible_user_realname = 32;
}

Field	Type	Description
id	string
name	string
author	string
title	string
creation_date	google.protobuf.Timestamp	** Optional.** ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
modification_date	google.protobuf.Timestamp	** Optional.** ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
icon	string
num_children	uint32
item_type	ItemType
effective_permission	EffectivePermission
force_two_factor	bool
max_users	uint32	** Optional.**
current_users	uint32	** Optional.**
unconfirmed_users	uint32	** Optional.**
inactive_users	uint32	** Optional.**
available_users	uint32	** Optional.**
has_user_flatrate	bool	** Optional.**
max_datarooms	uint32	** Optional.**
current_datarooms	uint32	** Optional.**
available_datarooms	uint32	** Optional.**
max_quantum	uint64	** Optional.**
current_quantum	uint64	** Optional.**
assigned_quantum	uint32	** Optional.**
available_quantum	uint32	** Optional.**
last_change_date	google.protobuf.Timestamp	** Optional.** ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
customer_id	string	** Optional.**
enterprise_type	DataroomType	** Optional.**
max_file_size	uint64	** Optional.**
responsible_username	string	** Optional.**
responsible_user_realname	string	** Optional.**

EnterpriseAccountProperties

Enterprise account settings

message EnterpriseAccountProperties {
 string id = 1;
 ItemType item_type = 10;
 SettingsEntryAsString title = 2;
 SettingsEntryAsBool force_two_factor = 3;
 optional SettingsEntryAsString denylisted_email_domains = 4;
 optional SettingsEntryAsString allowlisted_email_domains = 22;
 optional SettingsEntryAsString reset_password_email_address = 5;
 optional SettingsEntryAsLanguage email_language = 21;
 SettingsEntryAsBool enterprise_admins_may_administrate_users = 6;
 SettingsEntryAsBool dataroom_admins_may_not_change_email = 23;
 optional SettingsEntryAsString user_administration_email_address = 7;
 optional SettingsEntryAsEmailVerificationPeriod email_verification_period = 8;
 optional SettingsEntryAsInformationEmailType information_email_type = 9;
 optional SettingsEntryAsBool sso_enabled = 11;
 optional SettingsEntryAsString sso_login_address = 12;
 optional SettingsEntryAsSsoInterfaceType sso_interface_type = 13;
 optional SettingsEntryAsString sso_modulus = 14;
 optional SettingsEntryAsString sso_exponent = 15;
 optional SettingsEntryAsString sso_key_id = 16;
 optional SettingsEntryAsBool user_cleanup_enabled = 17;
 optional SettingsEntryAsAutomaticUserCleanupType user_cleanup_type = 18;
 optional SettingsEntryAsString user_cleanup_info_email_address = 19;
 optional SettingsEntryAsAutomaticUserCleanupInactivePeriod user_cleanup_inactive_period = 20; // protolint:disable:this MAX_LINE_LENGTH
 optional SettingsEntryAsString user_cleanup_list_name = 25;
 optional SettingsEntryAsString helpdesk_email_address = 24;
 optional SettingsEntryAsAutoLogOff auto_logoff = 26;
 optional SettingsEntryAsString sso_server = 27;
 optional SettingsEntryAsString sso_client_id = 28;
}

Field	Type	Description
id	string
item_type	ItemType
title	SettingsEntryAsString
force_two_factor	SettingsEntryAsBool
denylisted_email_domains	SettingsEntryAsString	** Optional.**
allowlisted_email_domains	SettingsEntryAsString	** Optional.**
reset_password_email_address	SettingsEntryAsString	** Optional.**
email_language	SettingsEntryAsLanguage	** Optional.**
enterprise_admins_may_administrate_users	SettingsEntryAsBool
dataroom_admins_may_not_change_email	SettingsEntryAsBool
user_administration_email_address	SettingsEntryAsString	** Optional.**
email_verification_period	SettingsEntryAsEmailVerificationPeriod	** Optional.**
information_email_type	SettingsEntryAsInformationEmailType	** Optional.**
sso_enabled	SettingsEntryAsBool	** Optional.**
sso_login_address	SettingsEntryAsString	** Optional.**
sso_interface_type	SettingsEntryAsSsoInterfaceType	** Optional.**
sso_modulus	SettingsEntryAsString	** Optional.**
sso_exponent	SettingsEntryAsString	** Optional.**
sso_key_id	SettingsEntryAsString	** Optional.**
user_cleanup_enabled	SettingsEntryAsBool	** Optional.**
user_cleanup_type	SettingsEntryAsAutomaticUserCleanupType	** Optional.**
user_cleanup_info_email_address	SettingsEntryAsString	** Optional.**
user_cleanup_inactive_period	SettingsEntryAsAutomaticUserCleanupInactivePeriod	** Optional.**
user_cleanup_list_name	SettingsEntryAsString	** Optional.**
helpdesk_email_address	SettingsEntryAsString	** Optional.**
auto_logoff	SettingsEntryAsAutoLogOff	** Optional.**
sso_server	SettingsEntryAsString	** Optional.**
sso_client_id	ettingsEntryAsString	** Optional.**

EnterpriseAccountTemplate

A template for default data room settings of an enterprise account

message DataroomTemplate {
 string id = 1;
 string title = 4;
 string name = 3;
 DataroomType dataroom_type = 5;
 optional DataroomSettings settings = 6;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp creation_date = 7;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp modification_date = 8;
 ItemType item_type = 10;
 EffectivePermission effective_permission = 11;
 optional uint32 num_of_datarooms = 12;
}

Field	Type	Description
id	string
title	string
name	string
dataroom_type	DataroomType
settings	DataroomSettings	Optional.
creation_date	google.protobuf.Timestamp	Optional. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
modification_date	google.protobuf.Timestamp	Optional. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
item_type	ItemType
effective_permission	EffectivePermission
num_of_datarooms	uint32	Optional.

EnterpriseAccountTemplateProperties

Data room properties of a template

message DataroomTemplateProperties {
 string id = 1;
 SettingsEntryAsString title = 4;
 SettingsEntryAsDataroomType dataroom_type = 5;
 ItemType item_type = 10;
 SettingsEntryAsDataroomSettings settings = 11;
}

Field	Type	Description
id	string
title	SettingsEntryAsString
dataroom_type	SettingsEntryAsDataroomType
item_type	ItemType
settings	SettingsEntryAsDataroomSettings

DataroomReportItem

Item of a data room report

message DataroomReportItem {
 string id = 1;
 string title = 4;
 string name = 3;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp creation_date = 7;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp modification_date = 8;
 ItemType item_type = 9;
 uint32 document_size = 10;
 EffectivePermission effective_permission = 11;
}

Field	Type	Description
id	string
title	string
name	string
creation_date	google.protobuf.Timestamp	Optional. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
modification_date	google.protobuf.Timestamp	Optional. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
item_type	ItemType
document_size	uint32
effective_permission	EffectivePermission

DataroomReportItemEntry

Entry of a data room report item

message DataroomReportItemEntry {
 string id = 1;
 string title = 4;
 string name = 3;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp creation_date = 7;
 // ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp modification_date = 8;
 ItemType item_type = 9;
 uint32 document_size = 10;
 EffectivePermission effective_permission = 11;
 uint32 sub_docs = 14;

 DataroomType dataroom_type = 62;

 optional string current_quantum_as_string = 73;
 optional string max_quantum_as_string = 75;
 optional uint32 current_users = 76;
 optional uint32 max_users = 77;

 // ProtoJSON Date Format - https://protobuf.dev/programming-guides/json/
 optional google.protobuf.Timestamp date_last_change = 80;

 optional string cost_center = 87;
}

Field	Type	Description
id	string
title	string
name	string
creation_date	google.protobuf.Timestamp	Optional. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
modification_date	google.protobuf.Timestamp	Optional. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
item_type	ItemType
document_size	uint32
effective_permission	EffectivePermission
sub_docs	uint32
dataroom_type	DataroomType
current_quantum_as_string	string	Optional.
max_quantum_as_string	string	Optional.
current_users	uint32	Optional.
max_users	uint32	Optional.
date_last_change	google.protobuf.Timestamp	Optional. ProtoJSON Date Format! - https://protobuf.dev/programming-guides/json/
cost_center	string	Optional.