V3 Policy structure for Create/Update

🚧 Warning

Updating a policy requires to send a whole data that was used for creation a policy with modification to be applied. There is no partial update.

AppliesTo

Configuration applies to policy

Field	Type	Required	Description
dataType	string	Yes	The list of data types that policy should apply to. Can't be empty. Can be one of [“Messages","RoomMeta", "SignalMeta", "FileContent", "FileMeta"]
action	string	Yes	Action to be taken on violation detection. Can be one of ["Block", "Warn", "LogOnly"]. The default is "LogOnly". Required - No for Action
rules	rules array_object See Rules	Yes	A Rule defines the matching specification for the policy. It holds a type and a corresponding configuration. The properties of the rule are used to build the match implementation. Only one of the following configuration properties should be set - [textMatchConfig, filePasswordConfig, fileClassifierConfig].

Rules

A Rule defines the matching specification for the policy.

Field	Type	Required	Description
type	string	Yes	Type of the rule used by the policy. Only one of the following configuration properties should be set - [“TEXT_MATCH", ","FILE_PASSWORD", "FILE_CLASSIFIER"].
name	string	Yes	Name for rule.
textMatchConfig	object	Only one of the configuration property should be set [textMatchConfig, fileClassifierConfig, filePasswordConfig].	This is a configuration that can be used to match text or regex. Configuration that can be used by a rule. This is a configuration that can be used to match text or regex. This configuration also corresponds to V2 TextMatch/RegexMatch of dictionaries. See TextMatchConfig
filePasswordConfig	object	Only one of the configuration property should be set [textMatchConfig, fileClassifierConfig, filePasswordConfig].	Password protected detection config for files that are password protected or not.
fileClassifierConfig	object	Only one of the configuration property should be set [textMatchConfig, fileClassifierConfig, filePasswordConfig].	File classifier config to check If files contain k-v pairs in the classifers map

TextMatchConfig

Field	Type	Required	Description
dictionaries	array_object see DictionaryMeta	Yes	List of dictionaries to apply in config. See DictionaryMeta
countUniqueOccurrences	string	Yes	Count of unique occurrences to be matched.
applicableFileTypes	array_string	File types must be applied only for rule type "FileContent", otherwise must be empty.	Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].

Field

DictionaryMeta

Field	Type	Required	Description
dictId	string	Yes	Unique dictionary identifier.
name	string	Yes	Dictionary version.
version	string	Yes	Dictionary name.

FileClassifierConfig

Field	Type	Required	Description
classifiers	Map<String, String>	Yes	Classifier is defined as a Key and its Value: e.g.: "classification": "Internal". Name and value can contain UTF-8 characters. Neither the name nor value cannot be left empty. Maximum 30 characters for the name and value, case insensitive. If files contains k-v pairs in the classifers map, it means a match. Maximum 30 classifiers per policy.
applicableFileTypes	array_string	Yes	File types that can be applied. Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].

FilePasswordConfig

Field	Type	Required	Description
applicableFileTypes	array_string	Yes	File types that can be applied. Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].
matchCriteria	array_string	Yes	Based on the criteria, whether a file is password protected or not means a match.Can be ["PASSWORD_PROTECTED". "NOT_PASSWORD_PROTECTED"]. The default is "NOT_PASSWORD_PROTECTED".