Manage custom sensitivity rules

A custom sensitivity rule allows you to define a sensitivity type that is not included in the Structural built-in types. For example, your data might include values that are specific to your organization.

Get the list of custom sensitivity rules

To retrieve the list of custom sensitivity rules and their current configuration, use:

GET api/sensitivityrule

For each rule, the response provides a SensitivityRuleSummary object that includes:

• Rule name

• Rule description

• The data type for matching columns

• The regular expression used to identify matching column names. Even if the sensitivity rule was configured in the Structural application to use text matching rules, the matching rules are converted to a regular expression.

• The identifier of the generator preset to recommend for matching columns

• The user who most recently updated the rule

• The timestamp when the rule was most recently updated

• The sequence number for the rule. The sequence numbers control the order in which Structural applies the sensitivity rules.

Create a sensitivity rule

To create a sensitivity rule, use:

POST api/sensitivityrule

In the request, you provide a SensitivityRuleRequestModel object that includes:

• Rule name

• An optional rule description

• The data type for matching columns

• The regular expression to use to identify matching column names. When you use the API to create a sensitivity rule, you must provide a regular expression. You cannot use text matching rules.

• The identifier of the generator preset to recommend for matching columns

Structural automatically adds the sensitivity rule to the end of the list. To assign a sequence number, you must edit the sensitivity rule.

Update a sensitivity rule

To update an existing sensitivity rule, use:

PATCH api/sensitivityrule

In the request, you provide an EditSensitivityRuleRequestModel object. In addition to the fields from the sensitivity rule creation, the object includes the order property, which sets the sequence number of the sensitivity rule. The sequence number determines the order in which Structural checks and applies the sensitivity rules.

Any changes to the sensitivity rule configuration are not applied until the next sensitivity scan.

When you change the sequence number, Structural automatically adjusts the sequence numbers of the other existing sensitivity rules.

Delete a sensitivity rule

To delete an existing sensitivity rule, use:

DELETE api/sensitivityrule/{sensitivityRuleId}