directory.exclude_rules

Background

This parameter specifies additional exclusion rules to eliminate unwanted directory entries.

Rules should be provided with space separation, and two forms or rule are supported

  • Name exclude rules: Eliminate any directory entries where the distinguished name of the entry matches the regular expression pattern given by the rule. Name exclude rules may contain any text (excluding white space and colons)

  • Attribute exclude rules: Eliminates any directory entries where the specified attribute contains text matching the given regular expression pattern. attribute exclude rules are expected to be in the form attribute:attribute_name:pattern.The name exclude rule Temp would exclude all directory entries in the Temp organisational unit (i.e. entries with a distinguished name line UID=bob,OU=Temp,DC=example,dc=com).

    The attribute exclude rule attribute:office:aust? would exclude all entries with an 'office' attribute set to aus or aust.

Within regular expression patterns, spaces can be expressed as \s if the patterns are required to match spaces.

Setting the key

Set this configuration key in the search package or data source configuration.

Use the configuration key editor to add or edit the directory.exclude_rules key, and set the value. This can be set to any valid List<String> value.

Default value

(none)

Examples

directory.exclude_rules=Temp attribute:office:aust.*