V3 Create Policy

Available on Agent 2.1.4 and above. See the SBE x Agent compatibilities for more details about the minimal requirements.
Creates a new policy with dictionary references.

After you create a policy, call Enable Policy to start enforcing the policy.

AppliesTo

Configuration applies to policy

FieldTypeRequiredDescription
dataTypestringYesThe list of data types that policy should apply to. Can't be empty. Can be ["Messages","RoomMeta", "SignalMeta", "FileContent", "FileMeta"].
actionstringYesAction to be taken on violation detection.
Can be ["Block", "Warn", "LogOnly"]. The default is "LogOnly".
rulesrules

array_object

See Rules
YesA Rule defines the actual matching specification for policies. It holds a type and a configuration for the rule, these properties should be used to build the corresponding matching implementation.
Only one of the configuration property should be set [textMatchConfig, fileSizeConfig, fileExtensionConfig, filePasswordConfig, fileClassifierConfig].

Rules

Configuration for rules

FieldTypeRequiredDescription
typestringYesType of a rule used by policy. Can be [" "TEXT_MATCH", "FILE_EXTENSION", "FILE_SIZE", "FILE_PASSWORD", "FILE_CLASSIFIER"].
namestringYesName for rule.
textMatchConfigobjectOnly one of the configuration property should be set [textMatchConfig, fileExtensionConfig, 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
filePasswordConfigobjectOnly one of the configuration property should be set [textMatchConfig, fileExtensionConfig, filePasswordConfig].Password protected detection config for files that are password protected or not.
fileExtensionConfigobjectOnly one of the configuration property should be set [textMatchConfig, fileExtensionConfig, filePasswordConfig].Extension detection config for allowed and blocked types of file extensions.

TextMatchConfig

FieldTypeRequiredDescription
dictionariesarray_object
see DictionaryMeta
YesList of dictionaries to apply in config. See DictionaryMeta
countUniqueOccurrencesstringYesCount of unique occurrences to be matched.
applicableFileTypesarray_stringFile types must be applied only for rule type "FileContent", otherwise must be empty.Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].

DictionaryMeta

FieldTypeRequiredDescription
dictIdstringYesUnique dictionary identifier.
namestringYesDictionary version.
versionstringYesDictionary name.

FileClassifierConfig

FieldTypeRequiredDescription
classifiersMap<String, String>YesClassifier 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.
applicableFileTypesarray_stringYesFile types that can be applied. Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].

FilePasswordConfig

Password protected detection config for files that are password protected or not.

FieldTypeRequiredDescription
applicableFileTypesarray_stringYesFile types that can be applied. Can be ["PDF", "WORD", "EXCEL", "POWERPOINT", "ZIP", "CSV", "TXT"].
matchCriteriaarray_stringYesBased 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".

🚧

Required Permissions

Calling this endpoint requires a Service User Account set with the Expression Filter Policy Management role. For more information about Service User accounts and their roles, see the Symphony Administration Guide.

See Bot Permissions for a list of roles and associated privileges.

Language